Bump version number

.woodpecker.yml

@@ -1,6 +0,0 @@
-pipeline:
-  test:
-    image: debian:bullseye
-    commands:
-      - apt-get update && apt-get install -y curl git make php-cli php-mbstring php-xml php-zip unzip p7zip-full
-      - make test

CHANGELOG.md

@@ -1,3 +1,3 @@
-## [1.0.0] - 2022-05-16
+## [1.0.0] - 2022-06-01
 ### Added
 - Create a Nextcloud app to send users to an external URL to change their password

Makefile

@@ -1,43 +1,14 @@
 # This file is licensed under the Affero General Public License version 3 or
 # later. See the COPYING file.
-# @author Bernhard Posselt <dev@bernhard-posselt.com>
+# @author Raoul Snyman <raoul@snyman.info>
-# @copyright Bernhard Posselt 2016
+# @copyright Raoul Snyman 2022
 
-# Generic Makefile for building and packaging a Nextcloud app which uses npm and
+# Makefile for building and packaging the "externalpassword" Nextcloud app.
-# Composer.
 #
 # Dependencies:
 # * make
-# * which
+# * docker
-# * curl: used if phpunit and composer are not installed to fetch them from the web
-# * tar: for building the archive
-# * npm: for building and testing everything JS
 #
-# If no composer.json is in the app root directory, the Composer step
-# will be skipped. The same goes for the package.json which can be located in
-# the app root or the js/ directory.
-#
-# The npm command by launches the npm build script:
-#
-#    npm run build
-#
-# The npm test command launches the npm test script:
-#
-#    npm run test
-#
-# The idea behind this is to be completely testing and build tool agnostic. All
-# build tools and additional package managers should be installed locally in
-# your project, since this won't pollute people's global namespace.
-#
-# The following npm scripts in your package.json install and update the bower
-# and npm dependencies and use gulp as build system (notice how everything is
-# run from the node_modules folder):
-#
-#    "scripts": {
-#        "test": "node node_modules/gulp-cli/bin/gulp.js karma",
-#        "prebuild": "npm install && node_modules/bower/bin/bower install && node_modules/bower/bin/bower update",
-#        "build": "node node_modules/gulp-cli/bin/gulp.js"
-#    },
 
 app_name=$(notdir $(CURDIR))
 build_tools_directory=$(CURDIR)/build/tools
@@ -45,48 +16,8 @@ source_build_directory=$(CURDIR)/build/artifacts/source
 source_package_name=$(source_build_directory)/$(app_name)
 appstore_build_directory=$(CURDIR)/build/artifacts/appstore
 appstore_package_name=$(appstore_build_directory)/$(app_name)
-npm=$(shell which npm 2> /dev/null)
-composer=$(shell which composer 2> /dev/null)
 
-all: build
+all: distclean source appstore
-
-# Fetches the PHP and JS dependencies and compiles the JS. If no composer.json
-# is present, the composer step is skipped, if no package.json or js/package.json
-# is present, the npm step is skipped
-.PHONY: build
-build:
-ifneq (,$(wildcard $(CURDIR)/composer.json))
-	make composer
-endif
-ifneq (,$(wildcard $(CURDIR)/package.json))
-	make npm
-endif
-ifneq (,$(wildcard $(CURDIR)/js/package.json))
-	make npm
-endif
-
-# Installs and updates the composer dependencies. If composer is not installed
-# a copy is fetched from the web
-.PHONY: composer
-composer:
-ifeq (, $(composer))
-	@echo "No composer command available, downloading a copy from the web"
-	mkdir -p $(build_tools_directory)
-	curl -sS https://getcomposer.org/installer | php
-	mv composer.phar $(build_tools_directory)
-	php $(build_tools_directory)/composer.phar install --prefer-dist
-else
-	composer install --prefer-dist
-endif
-
-# Installs npm dependencies
-.PHONY: npm
-npm:
-ifeq (,$(wildcard $(CURDIR)/package.json))
-	cd js && $(npm) run build
-else
-	npm run build
-endif
 
 # Removes the appstore build
 .PHONY: clean
@@ -145,11 +76,6 @@ appstore:
 	--exclude="../$(app_name)/js/.*" \
 	../$(app_name)
 
-.PHONY: test
-test: composer
-	$(CURDIR)/vendor/phpunit/phpunit/phpunit -c phpunit.xml
-	$(CURDIR)/vendor/phpunit/phpunit/phpunit -c phpunit.integration.xml
-
 .PHONY: sign
 sign: appstore
 	mkdir -p "$(CURDIR)/dist"
@@ -165,3 +91,4 @@ sign: appstore
 		--certificate=/certificates/externalpassword.crt
 	docker stop externalpassword-sign
 	cd "$(CURDIR)/dist" && tar -czf externalpassword.tar.gz externalpassword
+	(cd dist && openssl dgst -sha512 -sign ~/.nextcloud/certificates/externalpassword.key externalpassword.tar.gz | openssl base64)

README.md

@@ -12,22 +12,8 @@ The app can be built by using the provided Makefile by running:
 
 This requires the following things to be present:
 * make
-* which
+* docker: for signing the app
 * tar: for building the archive
-* curl: used if phpunit and composer are not installed to fetch them from the web
-* npm: for building and testing everything JS, only required if a package.json is placed inside the **js/** folder
-
-The make command will install or update Composer dependencies if a composer.json is present and also **npm run build** if a package.json is present in the **js/** folder. The npm **build** script should use local paths for build systems and package managers, so people that simply want to build the app won't need to install npm libraries globally, e.g.:
-
-**package.json**:
-```json
-"scripts": {
-    "test": "node node_modules/gulp-cli/bin/gulp.js karma",
-    "prebuild": "npm install && node_modules/bower/bin/bower install && node_modules/bower/bin/bower update",
-    "build": "node node_modules/gulp-cli/bin/gulp.js"
-}
-```
-
 
 ## Publish to App Store
 
@@ -36,20 +22,3 @@ First get an account for the [App Store](http://apps.nextcloud.com/) then run:
     make && make appstore
 
 The archive is located in build/artifacts/appstore and can then be uploaded to the App Store.
-
-## Running tests
-You can use the provided Makefile to run all tests by using:
-
-    make test
-
-This will run the PHP unit and integration tests and if a package.json is present in the **js/** folder will execute **npm run test**
-
-Of course you can also install [PHPUnit](http://phpunit.de/getting-started.html) and use the configurations directly:
-
-    phpunit -c phpunit.xml
-
-or:
-
-    phpunit -c phpunit.integration.xml
-
-for integration tests

appinfo/info.xml

@@ -5,7 +5,7 @@
     <name>External Password</name>
     <summary>An app for Nextcloud to allow an administrator to direct a user to an external site for changing their password.</summary>
     <description><![CDATA[An app for Nextcloud to allow an administrator to direct a user to an external site for changing their password. This is useful in conjunction with an app like external_users.]]></description>
-    <version>1.0.0</version>
+    <version>1.1.0</version>
     <licence>agpl</licence>
     <author mail="raoul@snyman.info" >Raoul Snyman</author>
     <namespace>ExternalPassword</namespace>
@@ -15,10 +15,12 @@
     <repository>https://git.snyman.info/raoul/externalpassword</repository>
     <bugs>https://git.snyman.info/raoul/externalpassword/issues</bugs>
     <dependencies>
-        <nextcloud min-version="22" max-version="25" />
+        <nextcloud min-version="22" max-version="26" />
     </dependencies>
     <settings>
         <admin>OCA\ExternalPassword\Settings\Admin</admin>
         <personal>OCA\ExternalPassword\Settings\Personal</personal>
+        <personal>OCA\ExternalPassword\Settings\Billing</personal>
+        <personal-section>OCA\ExternalPassword\Sections\Billing</personal-section>
     </settings>
 </info>

composer.json

@@ -1,15 +0,0 @@
-{
-  "name": "raoul/externalpassword",
-  "description": "An app for Nextcloud to allow an administrator to direct a user to an external site for changing their password.",
-  "type": "project",
-  "license": "AGPL",
-  "authors": [
-    {
-      "name": "Raoul Snyman"
-    }
-  ],
-  "require": {},
-  "require-dev": {
-    "phpunit/phpunit": "^9"
-  }
-}

img/billing.svg

@@ -0,0 +1,82 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   width="16"
+   height="16"
+   viewBox="0 0 4.2333332 4.2333333"
+   version="1.1"
+   id="svg1439"
+   inkscape:version="1.2.1 (9c6d41e410, 2022-07-14)"
+   sodipodi:docname="billing.svg"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:svg="http://www.w3.org/2000/svg">
+  <sodipodi:namedview
+     id="namedview1441"
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1.0"
+     inkscape:showpageshadow="2"
+     inkscape:pageopacity="0.0"
+     inkscape:pagecheckerboard="0"
+     inkscape:deskcolor="#d1d1d1"
+     inkscape:document-units="px"
+     showgrid="false"
+     inkscape:zoom="38.057741"
+     inkscape:cx="4.1910002"
+     inkscape:cy="5.9514831"
+     inkscape:window-width="2048"
+     inkscape:window-height="1089"
+     inkscape:window-x="0"
+     inkscape:window-y="0"
+     inkscape:window-maximized="1"
+     inkscape:current-layer="layer1" />
+  <defs
+     id="defs1436">
+    <inkscape:path-effect
+       effect="fillet_chamfer"
+       id="path-effect2197"
+       is_visible="true"
+       lpeversion="1"
+       nodesatellites_param="F,0,0,1,0,0.2,0,1 @ F,0,0,1,0,0.2,0,1 @ F,0,0,1,0,0.2,0,1 @ F,0,0,1,0,0.2,0,1 | F,0,0,1,0,0.2,0,1 @ F,0,0,1,0,0.2,0,1 @ F,0,0,1,0,0.2,0,1 @ F,0,0,1,0,0.2,0,1"
+       unit="px"
+       method="auto"
+       mode="F"
+       radius="0.2"
+       chamfer_steps="1"
+       flexible="false"
+       use_knot_distance="true"
+       apply_no_radius="true"
+       apply_with_radius="true"
+       only_selected="false"
+       hide_knots="false" />
+  </defs>
+  <g
+     inkscape:label="Layer 1"
+     inkscape:groupmode="layer"
+     id="layer1">
+    <path
+       id="rect1612"
+       style="stroke-width:1.06338;stroke-linecap:round;stroke-linejoin:round"
+       d="m 0,1.1260417 v 1.9812499 a 0.2,0.2 45 0 0 0.2,0.2 h 3.8333332 a 0.2,0.2 135 0 0 0.2,-0.2 V 1.1260417 a 0.2,0.2 45 0 0 -0.2,-0.20000005 l -3.8333332,0 A 0.2,0.2 135 0 0 0,1.1260417 Z M 0.59687499,1.3229166 H 3.6364583 a 0.2,0.2 45 0 1 0.2,0.2 v 1.1875 a 0.2,0.2 135 0 1 -0.2,0.2 H 0.59687499 a 0.2,0.2 45 0 1 -0.2,-0.2 v -1.1875 a 0.2,0.2 135 0 1 0.2,-0.2 z"
+       sodipodi:nodetypes="cccccccccc"
+       inkscape:path-effect="#path-effect2197"
+       inkscape:original-d="M 0,0.92604165 V 3.3072916 H 4.2333332 V 0.92604165 Z M 0.39687499,1.3229166 H 3.8364583 v 1.5875 H 0.39687499 Z" />
+    <circle
+       style="fill:#000000;stroke-width:0.803987;stroke-linecap:round;stroke-linejoin:round"
+       id="path1671"
+       cx="2.1166666"
+       cy="2.1166666"
+       r="0.52916664" />
+    <path
+       id="circle1934"
+       style="stroke-width:1.20598;stroke-linecap:round;stroke-linejoin:round"
+       d="m 4.2333332,1.3229166 v 1.5875 a 0.79374998,0.79375002 0 0 1 -0.79375,-0.7937501 0.79374998,0.79375002 0 0 1 0.79375,-0.7937499 z" />
+    <path
+       id="path1941"
+       style="stroke-width:1.20598;stroke-linecap:round;stroke-linejoin:round"
+       d="m 0,1.3229166 v 1.5875 A 0.79374998,0.79375002 0 0 0 0.79374998,2.1166665 0.79374998,0.79375002 0 0 0 0,1.3229166 Z" />
+  </g>
+</svg>

lib/Controller/SettingsController.php

@@ -47,10 +47,14 @@ class SettingsController extends Controller {
      * @param string $descriptionText
      * @param string $buttonText
 	 */
-	public function save(string $changePasswordUrl, string $descriptionText, string $buttonText): JSONResponse {
+    public function save(string $changePasswordUrl, string $descriptionText, string $buttonText,
+                         string $billingUrl, string $billingDescriptionText, string $billingButtonText): JSONResponse {
         $this->config->setAppValue('externalpassword', 'changePasswordUrl', $changePasswordUrl);
         $this->config->setAppValue('externalpassword', 'descriptionText', $descriptionText);
         $this->config->setAppValue('externalpassword', 'buttonText', $buttonText);
+        $this->config->setAppValue('externalpassword', 'billingUrl', $billingUrl);
+        $this->config->setAppValue('externalpassword', 'billingDescriptionText', $billingDescriptionText);
+        $this->config->setAppValue('externalpassword', 'billingButtonText', $billingButtonText);
         $parameters = [
             'status' => 'success',
             'data' => [

lib/Sections/Billing.php

@@ -0,0 +1,32 @@
+<?php
+namespace OCA\ExternalPassword\Sections;
+
+use OCP\IL10N;
+use OCP\IURLGenerator;
+use OCP\Settings\IIconSection;
+
+class Billing implements IIconSection {
+    private IL10N $l;
+    private IURLGenerator $urlGenerator;
+
+    public function __construct(IL10N $l, IURLGenerator $urlGenerator) {
+        $this->l = $l;
+        $this->urlGenerator = $urlGenerator;
+    }
+
+    public function getIcon(): string {
+        return $this->urlGenerator->imagePath('externalpassword', 'billing.svg');
+    }
+
+    public function getID(): string {
+        return 'billing';
+    }
+
+    public function getName(): string {
+        return $this->l->t('Billing');
+    }
+
+    public function getPriority(): int {
+        return 1;
+    }
+}

lib/Settings/Admin.php

@@ -50,14 +50,24 @@ class Admin implements ISettings {
      * @return TemplateResponse
      */
     public function getForm() {
+        # Password section
         $changePasswordUrl = $this->config->getAppValue('externalpassword', 'changePasswordUrl', '');
         $descriptionText = $this->config->getAppValue('externalpassword', 'descriptionText',
             'Your password is managed externally, please click the button below to change your password.');
         $buttonText = $this->config->getAppValue('externalpassword', 'buttonText', 'Change password');
+        # Billing section
+        $billingUrl = $this->config->getAppValue('externalpassword', 'billingUrl', '');
+        $billingDescriptionText = $this->config->getAppValue('externalpassword', 'billingDescriptionText',
+            'Your account billing is managed externally, please click the button below to manage your account.');
+        $billingButtonText = $this->config->getAppValue('externalpassword', 'billingButtonText', 'Manage billing');
+
         $parameters = [
             'changePasswordUrl' => $changePasswordUrl,
             'descriptionText' => $descriptionText,
-            'buttonText' => $buttonText
+            'buttonText' => $buttonText,
+            'billingUrl' => $billingUrl,
+            'billingDescriptionText' => $billingDescriptionText,
+            'billingButtonText' => $billingButtonText
         ];
         return new TemplateResponse('externalpassword', 'settings/admin', $parameters);
     }

lib/Settings/Billing.php

@@ -0,0 +1,87 @@
+<?php
+/**
+ * @copyright Copyright (c) 2022 Raoul Snyman <raoul@snyman.info>
+ *
+ * @author Raoul Snyman <raoul@snyman.info>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+namespace OCA\ExternalPassword\Settings;
+
+use OCP\AppFramework\Http\TemplateResponse;
+use OCP\IConfig;
+use OCP\IL10N;
+use OCP\Settings\ISettings;
+
+class Billing implements ISettings {
+
+    /** @var IConfig */
+    private $config;
+
+    /** @var IL10N */
+    private $l;
+
+    /**
+     * Admin constructor.
+     *
+     * @param IConfig $config
+     * @param IL10N $l
+     */
+    public function __construct(IConfig $config, IL10N $l) {
+        $this->config = $config;
+        $this->l = $l;
+    }
+
+    /**
+     * @return TemplateResponse
+     */
+    public function getForm() {
+        $billingUrl = $this->config->getAppValue('externalpassword', 'billingUrl', '');
+        $billingDescriptionText = $this->config->getAppValue('externalpassword', 'billingDescriptionText',
+            'Your account billing is managed externally, please click the button below to manage your account.');
+        $billingButtonText = $this->config->getAppValue('externalpassword', 'billingButtonText', 'Manage billing');
+        $parameters = [
+            'billingUrl' => $billingUrl,
+            'billingDescriptionText' => $billingDescriptionText,
+            'billingButtonText' => $billingButtonText
+        ];
+        return new TemplateResponse('externalpassword', 'settings/billing', $parameters);
+    }
+
+    /**
+     * @return string the section ID, e.g. 'sharing'
+     */
+    public function getSection() {
+        $billingUrl = $this->config->getAppValue('externalpassword', 'billingUrl', '');
+        if (!$billingUrl) {
+            return null;
+        }
+        else {
+            return 'billing';
+        }
+    }
+
+    /**
+     * @return int whether the form should be rather on the top or bottom of
+     * the admin section. The forms are arranged in ascending order of the
+     * priority values. It is required to return a value between 0 and 100.
+     */
+    public function getPriority() {
+        return 10;
+    }
+
+}

phpunit.integration.xml

@@ -1,7 +0,0 @@
-<phpunit bootstrap="tests/bootstrap.php" colors="true">
-    <testsuites>
-        <testsuite name="integration">
-            <directory>./tests/Integration</directory>
-        </testsuite>
-    </testsuites>
-</phpunit>

phpunit.xml

@@ -1,7 +0,0 @@
-<phpunit bootstrap="tests/bootstrap.php" colors="true">
-    <testsuites>
-        <testsuite name="unit">
-            <directory>./tests/Unit</directory>
-        </testsuite>
-    </testsuites>
-</phpunit>

templates/settings/admin.php

@@ -27,7 +27,7 @@ style('externalpassword', 'admin');
 <div id="security-externalpassword" class="section">
     <h2 class="inlineblock"><?php p($l->t('External Password'));?></h2>
     <span id="externalpassword-error-msg" class="msg success hidden">Saved</span>
-    <p class="settings-hint"><?php p($l->t('To direct users to an external website in order to change their password, set the URL below.')); ?></p>
+    <p class="settings-hint"><?php p($l->t('To direct users to an external website in order to change their password or update their billing, set the URLs below.')); ?></p>
     <div class="admin-settings-externalpassword">
         <form id="externalpassword-form" method="POST">
             <div class="form-section">
@@ -35,13 +35,25 @@ style('externalpassword', 'admin');
                 <input type="text" id="change-password-url" name="changePasswordUrl" value="<?php p($_['changePasswordUrl']); ?>" />
             </div>
             <div class="form-section">
-                <label for="description-text"><?php p($l->t('Description')); ?></label>
+                <label for="description-text"><?php p($l->t('Password description')); ?></label>
                 <input type="text" id="description-text" name="descriptionText" value="<?php p($_['descriptionText']); ?>" />
             </div>
             <div class="form-section">
-                <label for="button-text"><?php p($l->t('Button text')); ?></label>
+                <label for="button-text"><?php p($l->t('Password button text')); ?></label>
                 <input type="text" id="button-text" name="buttonText" value="<?php p($_['buttonText']); ?>" class="small" />
             </div>
+            <div class="form-section">
+                <label for="billing-url"><?php p($l->t('External billing URL')); ?></label>
+                <input type="text" id="billing-url" name="billingUrl" value="<?php p($_['billingUrl']); ?>" />
+            </div>
+            <div class="form-section">
+                <label for="billing-description-text"><?php p($l->t('Billing description')); ?></label>
+                <input type="text" id="billing-description-text" name="billingDescriptionText" value="<?php p($_['billingDescriptionText']); ?>" />
+            </div>
+            <div class="form-section">
+                <label for="billing-button-text"><?php p($l->t('Billing button text')); ?></label>
+                <input type="text" id="billing-button-text" name="billingButtonText" value="<?php p($_['billingButtonText']); ?>" class="small" />
+            </div>
             <input type="submit" id="externalpassword-save" value="<?php p($l->t('Save')); ?>" />
         </form>
     </div>

templates/settings/billing.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * @copyright Copyright (c) 2022 Raoul Snyman <raoul@snyman.info>
+ *
+ * @author Raoul Snyman <raoul@snyman.info>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+?>
+<?php if ($_['billingUrl']) { ?>
+<div id="security-external-password" class="section">
+	<h2><?php p($l->t('Billing'));?></h2>
+    <div>
+        <p class="settings-hint"><?php p($_['billingDescriptionText']); ?></p>
+        <p><a href="<?php p($_['billingUrl']); ?>" class="button" target="_blank"><?php p($_['billingButtonText']); ?></a></p>
+    </div>
+</div>
+<?php } ?>