refactor: remove imagick dependency (#5143)

asbiin · web-flow · commit 5fc458478f05 · 2021-05-02T14:35:41.000+02:00
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -36,7 +36,7 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ env.php-version }}
-          extensions: imagick, redis
+          extensions: redis
           coverage: none
       - name: Check PHP Version
         run: php -v
diff --git a/.github/workflows/cypress.yml b/.github/workflows/cypress.yml
@@ -29,7 +29,7 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php-version }}
-          extensions: imagick, redis
+          extensions: redis
           coverage: none
       - name: Check PHP Version
         run: php -v
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -41,7 +41,7 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ env.php-version }}
-          extensions: imagick, redis
+          extensions: redis
           coverage: none
       - name: Check PHP Version
         run: php -v
diff --git a/.github/workflows/migration_tests.yml b/.github/workflows/migration_tests.yml
@@ -35,7 +35,7 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php-version }}
-          extensions: imagick, redis, ${{ matrix.connection }}
+          extensions: redis, ${{ matrix.connection }}
           coverage: none
       - name: Check PHP Version
         run: php -v
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -77,7 +77,7 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ env.php-version }}
-          extensions: imagick, redis
+          extensions: redis
           coverage: none
 
     # Composer
diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml
@@ -23,7 +23,7 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ env.php-version }}
-          extensions: imagick, redis
+          extensions: redis
           coverage: none
 
       - name: Get Composer Cache Directory
@@ -56,7 +56,7 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ env.php-version }}
-          extensions: imagick, redis
+          extensions: redis
           coverage: none
 
       - name: Get Composer Cache Directory
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -41,7 +41,7 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php-version }}
-          extensions: imagick, redis, ${{ matrix.connection }}
+          extensions: redis, ${{ matrix.connection }}
           coverage: none
       - name: Check PHP Version
         run: php -v
@@ -155,7 +155,7 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php-version }}
-          extensions: imagick, redis, ${{ matrix.connection }}
+          extensions: redis, ${{ matrix.connection }}
           coverage: xdebug
       - name: Check PHP Version
         run: php -v
diff --git a/.platform.app.yaml b/.platform.app.yaml
@@ -15,7 +15,6 @@ runtime:
     - gmp
     - redis
     - sodium
-    - imagick
 
 # The hooks that will be performed when the package is deployed.
 hooks:
diff --git a/composer.json b/composer.json
@@ -13,7 +13,6 @@
         "ext-bcmath": "*",
         "ext-gd": "*",
         "ext-gmp": "*",
-        "ext-imagick": "*",
         "ext-intl": "*",
         "ext-redis": "*",
         "asbiin/laravel-webauthn": "^1.0",
diff --git a/composer.lock b/composer.lock
diff --git a/config/google2fa.php b/config/google2fa.php
@@ -3,43 +3,45 @@
 return [
 
     /*
-     * Auth container binding
+     * Enable / disable Google2FA.
      */
-
     'enabled' => env('MFA_ENABLED', env('2FA_ENABLED', true)),
 
     /*
      * Lifetime in minutes.
+     *
      * In case you need your users to be asked for a new one time passwords from time to time.
      */
-
-    'lifetime' => 0, // 0 = eternal
+    'lifetime' => env('OTP_LIFETIME', 0), // 0 = eternal
 
     /*
      * Renew lifetime at every new request.
      */
-
-    'keep_alive' => true,
+    'keep_alive' => env('OTP_KEEP_ALIVE', true),
 
     /*
-     * Auth container binding
+     * Auth container binding.
      */
-
     'auth' => 'auth',
 
     /*
-     * 2FA verified session var
+     * Guard.
+     */
+    'guard' => '',
+
+    /*
+     * 2FA verified session var.
      */
 
     'session_var' => 'google2fa',
 
     /*
-     * One Time Password request input name
+     * One Time Password request input name.
      */
     'otp_input' => 'one_time_password',
 
     /*
-     * One Time Password Window
+     * One Time Password Window.
      */
     'window' => 8,
 
@@ -49,22 +51,34 @@
     'forbid_old_passwords' => false,
 
     /*
-     * User's table column for google2fa secret
+     * User's table column for google2fa secret.
      */
     'otp_secret_column' => 'google2fa_secret',
 
     /*
-     * One Time Password View
+     * One Time Password View.
      */
     'view' => 'auth/validate2fa',
 
     /*
-     * One Time Password error message
+     * One Time Password error message.
      */
     'error_messages' => [
-        'wrong_otp' => 'The two factor authentication has failed.',
+        'wrong_otp'       => "The 'One Time Password' typed was wrong.",
         'cannot_be_empty' => 'One Time Password cannot be empty.',
-        'unknown' => 'An unknown error has occurred. Please try again.',
+        'unknown'         => 'An unknown error has occurred. Please try again.',
     ],
 
+    /*
+     * Throw exceptions or just fire events?
+     */
+    'throw_exceptions' => env('OTP_THROW_EXCEPTION', true),
+
+    /*
+     * Which image backend to use for generating QR codes?
+     *
+     * Supports imagemagick, svg and eps
+     */
+    'qrcode_image_backend' => \PragmaRX\Google2FALaravel\Support\Constants::QRCODE_IMAGE_BACKEND_SVG,
+
 ];
diff --git a/docs/installation/providers/cpanel.md b/docs/installation/providers/cpanel.md
@@ -39,7 +39,6 @@ Monica can be configured in shared hosting environments with a little difference
 -   sodium
 -   xml
 -   zip
--   imagick
 
 In most cases, this will be under the section called 'PHP Version' in cPanel where you can enable and disable modules. 
 
diff --git a/docs/installation/providers/debian.md b/docs/installation/providers/debian.md
@@ -45,7 +45,7 @@ sudo apt install -y git
 Install PHP 7.4 with these extensions:
 
 ```sh
-sudo apt install -y php php-bcmath php-curl php-gd php-gmp php-imagick \
+sudo apt install -y php php-bcmath php-curl php-gd php-gmp \
     php-intl php-mbstring php-mysql php-redis php-xml php-zip
 ```
 
diff --git a/docs/installation/providers/generic.md b/docs/installation/providers/generic.md
@@ -47,7 +47,6 @@ If you don't want to use Docker, the best way to setup the project is to use the
 -   sodium
 -   xml
 -   zip
--   imagick
 
 **Composer:** After you're done installing PHP, you'll need the Composer dependency manager. It is not enough to just install Composer, you also need to make sure it is installed globally for Monica's installation to run smoothly:
 
diff --git a/docs/installation/providers/ubuntu.md b/docs/installation/providers/ubuntu.md
@@ -56,8 +56,8 @@ Then install php 7.4 with these extensions:
 ```sh
 sudo apt update
 sudo apt install -y php7.4 php7.4-bcmath php7.4-cli php7.4-curl php7.4-common \
-    php7.4-fpm php7.4-gd php7.4-gmp php7.4-imagick php7.4-intl php7.4-json \
-    php7.4-mbstring php7.4-mysql php7.4-opcache php7.4-redis php7.4-xml php7.4-zip
+    php7.4-fpm php7.4-gd php7.4-gmp php7.4-intl php7.4-json php7.4-mbstring \
+    php7.4-mysql php7.4-opcache php7.4-redis php7.4-xml php7.4-zip
 ```
 
 **Composer:** After you're done installing PHP, you'll need the [Composer](https://getcomposer.org/download/) dependency manager.
diff --git a/resources/js/components/settings/MfaActivate.vue b/resources/js/components/settings/MfaActivate.vue
@@ -19,9 +19,8 @@
 
         <div class="panel-body">
           {{ $t('settings.2fa_enable_otp') }}
+          <div v-html="image"></div>
           <p>
-            <img id="barcode" alt="Image of QR barcode" :src="image" />
-            <br />
             {{ $t('settings.2fa_enable_otp_help') }}
             <code id="secretkey">
               {{ secret }}
diff --git a/scripts/docker/Dockerfile b/scripts/docker/Dockerfile
@@ -64,13 +64,11 @@ RUN set -ex; \
     pecl install APCu; \
     pecl install memcached; \
     pecl install redis; \
-    pecl install imagick; \
     \
     docker-php-ext-enable \
         apcu \
         memcached \
         redis \
-        imagick \
     ; \
     \
 # reset apt-mark's "manual" list so that "purge --auto-remove" will remove all build dependencies
diff --git a/scripts/vagrant/build/install-monica.sh b/scripts/vagrant/build/install-monica.sh
@@ -52,8 +52,8 @@ curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin
 
 echo -e "\n\033[4;32mInstalling packages for Monica\033[0;40m"
 apt-get install -y php7.4-bcmath php7.4-cli php7.4-curl php7.4-common php7.4-fpm \
-    php7.4-gd php7.4-gmp php7.4-imagick php7.4-intl php7.4-json php7.4-mbstring \
-    php7.4-mysql php7.4-opcache php7.4-redis php7.4-xml php7.4-zip >/dev/null
+    php7.4-gd php7.4-gmp php7.4-intl php7.4-json php7.4-mbstring php7.4-mysql \
+    php7.4-opcache php7.4-redis php7.4-xml php7.4-zip >/dev/null
 
 echo -e "\n\033[4;32mInstalling node.js\033[0;40m"
 curl -fsSL https://deb.nodesource.com/setup_14.x | bash - >/dev/null

-Original file line number
+Diff line change
     - gmp
     - redis
     - sodium
 -    - imagick
 # The hooks that will be performed when the package is deployed.
 hooks: