├── js └── .gitkeep ├── img ├── screenshot1.jpg ├── screenshot2.jpg ├── yaml_widget-video.jpg ├── template_widget-video.jpg ├── logo-dark.svg └── app.svg ├── .gitattributes ├── .eslintrc.js ├── stylelint.config.js ├── .gitignore ├── .github └── workflows │ ├── reuse.yml │ ├── lint-info-xml.yml │ ├── lint-php-cs.yml │ ├── lint-php.yml │ ├── lint-eslint.yml │ ├── lint-stylelint.yml │ ├── phpunit-sqlite.yml │ ├── phpunit-oci.yml │ ├── phpunit-pgsql.yml │ └── phpunit-mysql.yml ├── .php_cs-fixer.dist.php ├── .reuse └── dep5 ├── appinfo ├── routes.php └── info.xml ├── lib ├── Sections │ └── HAssAdmin.php ├── AppInfo │ └── Application.php ├── Service │ └── HassIntegrationService.php ├── Listener │ └── AddContentSecurityPolicyListener.php ├── Controller │ └── HassIntegrationController.php ├── Settings │ └── AdminSettings.php └── Dashboard │ ├── YamlWidget.php │ └── TemplateWidget.php ├── src ├── templateWidget.js ├── admin-settings.js └── yamlWidget.js ├── composer.json ├── webpack.config.js ├── css ├── admin-settings.css └── dashboard.css ├── package.json ├── README.md ├── templates └── admin-settings.php ├── Makefile └── LICENSES ├── CC0-1.0.txt └── AGPL-3.0-or-later.txt /js/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /img/screenshot1.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/poulou0/nextcloud-homeassistant-integration/HEAD/img/screenshot1.jpg -------------------------------------------------------------------------------- /img/screenshot2.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/poulou0/nextcloud-homeassistant-integration/HEAD/img/screenshot2.jpg -------------------------------------------------------------------------------- /img/yaml_widget-video.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/poulou0/nextcloud-homeassistant-integration/HEAD/img/yaml_widget-video.jpg -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: Poulou 2 | # SPDX-License-Identifier: AGPL-3.0-or-later 3 | /js/* binary 4 | -------------------------------------------------------------------------------- /img/template_widget-video.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/poulou0/nextcloud-homeassistant-integration/HEAD/img/template_widget-video.jpg -------------------------------------------------------------------------------- /.eslintrc.js: -------------------------------------------------------------------------------- 1 | // SPDX-FileCopyrightText: Poulou 2 | // SPDX-License-Identifier: AGPL-3.0-or-later 3 | module.exports = { 4 | extends: [ 5 | '@nextcloud', 6 | ] 7 | } 8 | -------------------------------------------------------------------------------- /stylelint.config.js: -------------------------------------------------------------------------------- 1 | // SPDX-FileCopyrightText: Nextcloud contributors 2 | // SPDX-License-Identifier: AGPL-3.0-or-later 3 | const stylelintConfig = require('@nextcloud/stylelint-config') 4 | 5 | module.exports = stylelintConfig 6 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: Poulou 2 | # SPDX-License-Identifier: AGPL-3.0-or-later 3 | .idea 4 | *.iml 5 | composer.lock 6 | /vendor/ 7 | /build/ 8 | node_modules/ 9 | /.php_cs.cache 10 | js/*hot-update.* 11 | js/*.js 12 | js/*.map 13 | js/*.txt -------------------------------------------------------------------------------- /.github/workflows/reuse.yml: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2022 Free Software Foundation Europe e.V. 2 | # 3 | # SPDX-License-Identifier: CC0-1.0 4 | 5 | name: REUSE Compliance Check 6 | 7 | on: [push, pull_request] 8 | 9 | jobs: 10 | test: 11 | runs-on: ubuntu-latest 12 | steps: 13 | - uses: actions/checkout@v2 14 | - name: REUSE Compliance Check 15 | uses: fsfe/reuse-action@v1 -------------------------------------------------------------------------------- /.php_cs-fixer.dist.php: -------------------------------------------------------------------------------- 1 | 5 | // SPDX-License-Identifier: AGPL-3.0-or-later 6 | 7 | require_once './vendor/autoload.php'; 8 | 9 | use Nextcloud\CodingStandard\Config; 10 | 11 | $config = new Config(); 12 | $config 13 | ->getFinder() 14 | ->ignoreVCSIgnored(true) 15 | ->notPath('build') 16 | ->notPath('l10n') 17 | ->notPath('src') 18 | ->notPath('vendor') 19 | ->in(__DIR__); 20 | return $config; 21 | -------------------------------------------------------------------------------- /.reuse/dep5: -------------------------------------------------------------------------------- 1 | Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ 2 | Upstream-Name: Hass Integration 3 | Upstream-Contact: Poulou 4 | Source: https://github.com/nextcloud/profiler 5 | 6 | Files: package-lock.json package.json composer.json composer.lock lib/*/* css/* js/* src/* templates/* img/* 7 | Copyright: Poulou 8 | License: AGPL-3.0-or-later 9 | 10 | Files: l10n/*.js l10n/*.json 11 | Copyright: Nextcloud translators 12 | License: AGPL-3.0-or-later 13 | -------------------------------------------------------------------------------- /appinfo/routes.php: -------------------------------------------------------------------------------- 1 | 4 | // SPDX-License-Identifier: AGPL-3.0-or-later 5 | 6 | /** 7 | * Create your routes in here. The name is the lowercase name of the controller 8 | * without the controller part, the stuff after the hash is the method. 9 | * e.g. page#index -> OCA\HassIntegration\Controller\PageController->index() 10 | * 11 | * The controller class has to be registered in the application.php file since 12 | * it's instantiated in there 13 | */ 14 | return [ 15 | 'routes' => [ 16 | ['name' => 'hassIntegration#templatePost', 'url' => '/template', 'verb' => 'POST'], 17 | ['name' => 'hassIntegration#togglePost', 'url' => '/toggle', 'verb' => 'POST'], 18 | ['name' => 'hassIntegration#runScriptPost', 'url' => '/run_script', 'verb' => 'POST'], 19 | ], 20 | ]; 21 | -------------------------------------------------------------------------------- /lib/Sections/HAssAdmin.php: -------------------------------------------------------------------------------- 1 | l = $l; 16 | $this->urlGenerator = $urlGenerator; 17 | } 18 | 19 | public function getIcon(): string { 20 | return $this->urlGenerator->imagePath(Application::APP_ID, 'logo-dark.svg'); 21 | } 22 | 23 | public function getID(): string { return self::SETTINGS_SECTION; } 24 | 25 | public function getName(): string { return $this->l->t('Home assistant integration'); } 26 | 27 | public function getPriority(): int { return 98; } 28 | } 29 | -------------------------------------------------------------------------------- /.github/workflows/lint-info-xml.yml: -------------------------------------------------------------------------------- 1 | # This workflow is provided via the organization template repository 2 | # 3 | # https://github.com/nextcloud/.github 4 | # https://docs.github.com/en/actions/learn-github-actions/sharing-workflows-with-your-organization 5 | # SPDX-FileCopyrightText: Nextcloud contributors 6 | # SPDX-License-Identifier: AGPL-3.0-or-later 7 | 8 | name: Lint 9 | 10 | on: 11 | pull_request: 12 | push: 13 | branches: 14 | - main 15 | - master 16 | - stable* 17 | 18 | jobs: 19 | xml-linters: 20 | runs-on: ubuntu-latest 21 | 22 | name: info.xml lint 23 | steps: 24 | - name: Checkout 25 | uses: actions/checkout@master 26 | 27 | - name: Download schema 28 | run: wget https://raw.githubusercontent.com/nextcloud/appstore/master/nextcloudappstore/api/v1/release/info.xsd 29 | 30 | - name: Lint info.xml 31 | uses: ChristophWurst/xmllint-action@v1 32 | with: 33 | xml-file: ./appinfo/info.xml 34 | xml-schema-file: ./info.xsd 35 | -------------------------------------------------------------------------------- /.github/workflows/lint-php-cs.yml: -------------------------------------------------------------------------------- 1 | # This workflow is provided via the organization template repository 2 | # 3 | # https://github.com/nextcloud/.github 4 | # https://docs.github.com/en/actions/learn-github-actions/sharing-workflows-with-your-organization 5 | # SPDX-FileCopyrightText: Nextcloud contributors 6 | # SPDX-License-Identifier: AGPL-3.0-or-later 7 | 8 | name: Lint 9 | 10 | on: 11 | pull_request: 12 | push: 13 | branches: 14 | - master 15 | - stable* 16 | 17 | jobs: 18 | lint: 19 | runs-on: ubuntu-latest 20 | 21 | name: php-cs 22 | 23 | steps: 24 | - name: Checkout 25 | uses: actions/checkout@v2 26 | 27 | - name: Set up php ${{ matrix.php-versions }} 28 | uses: shivammathur/setup-php@v2 29 | with: 30 | php-version: "7.4" 31 | coverage: none 32 | 33 | - name: Install dependencies 34 | run: composer i 35 | 36 | - name: Lint 37 | run: composer run cs:check || ( echo 'Please run `composer run cs:fix` to format your code' && exit 1 ) 38 | 39 | -------------------------------------------------------------------------------- /src/templateWidget.js: -------------------------------------------------------------------------------- 1 | import { loadState } from '@nextcloud/initial-state' 2 | import axios from '@nextcloud/axios' 3 | import { generateUrl } from '@nextcloud/router' 4 | 5 | document.addEventListener('DOMContentLoaded', () => { 6 | OCA.Dashboard.register('hass-template-widget', (el, { widget }) => { 7 | el.innerHTML = nl2br(loadState('integration_homeassistant', 'dashboard-template-widget')) 8 | if (!el.innerHTML) el.innerHTML = emptyMsg() 9 | el.parentElement.style.overflow = 'auto' 10 | const refreshInterval = parseInt(loadState('integration_homeassistant', 'dashboard-template-widget-refresh-interval')) 11 | if (refreshInterval > 0) { 12 | setInterval(async () => { 13 | el.innerHTML = nl2br((await axios.post(generateUrl('/apps/integration_homeassistant/template'))).data[0]) 14 | if (!el.innerHTML) el.innerHTML = emptyMsg() 15 | }, refreshInterval * 1000) 16 | } 17 | }) 18 | }) 19 | 20 | /** 21 | * Replace line breaks with
22 | * @param {string} s The variable to convert 23 | */ 24 | function nl2br(s) { 25 | return s.toString().replace(/(?:\r\n|\r|\n)/g, '
') 26 | } 27 | 28 | /** 29 | * Prints guide 30 | */ 31 | function emptyMsg() { return 'Nothing to show ::)

Go to "Administrator settings" > "Home assistant integration" to get started.' } 32 | -------------------------------------------------------------------------------- /lib/AppInfo/Application.php: -------------------------------------------------------------------------------- 1 | 4 | // SPDX-License-Identifier: AGPL-3.0-or-later 5 | 6 | namespace OCA\HassIntegration\AppInfo; 7 | 8 | use OCA\HassIntegration\Listener\AddContentSecurityPolicyListener; 9 | use OCA\HassIntegration\Dashboard\TemplateWidget; 10 | use OCA\HassIntegration\Dashboard\YamlWidget; 11 | use OCP\AppFramework\App; 12 | use OCP\AppFramework\Bootstrap\IRegistrationContext; 13 | use OCP\AppFramework\Bootstrap\IBootContext; 14 | use OCP\AppFramework\Bootstrap\IBootstrap; 15 | use OCP\Security\CSP\AddContentSecurityPolicyEvent; 16 | 17 | class Application extends App implements IBootstrap 18 | { 19 | public const APP_ID = 'integration_homeassistant'; 20 | 21 | public function __construct(array $urlParams = []) 22 | { 23 | parent::__construct(self::APP_ID, $urlParams); 24 | } 25 | 26 | public function register(IRegistrationContext $context): void 27 | { 28 | $context->registerDashboardWidget(TemplateWidget::class); 29 | $context->registerDashboardWidget(YamlWidget::class); 30 | 31 | $context->registerEventListener(AddContentSecurityPolicyEvent::class, AddContentSecurityPolicyListener::class); 32 | } 33 | 34 | public function boot(IBootContext $context): void 35 | { 36 | } 37 | } 38 | -------------------------------------------------------------------------------- /.github/workflows/lint-php.yml: -------------------------------------------------------------------------------- 1 | # This workflow is provided via the organization template repository 2 | # 3 | # https://github.com/nextcloud/.github 4 | # https://docs.github.com/en/actions/learn-github-actions/sharing-workflows-with-your-organization 5 | # SPDX-FileCopyrightText: Nextcloud contributors 6 | # SPDX-License-Identifier: AGPL-3.0-or-later 7 | 8 | name: Lint 9 | 10 | on: 11 | pull_request: 12 | push: 13 | branches: 14 | - main 15 | - master 16 | - stable* 17 | 18 | jobs: 19 | php-lint: 20 | runs-on: ubuntu-latest 21 | strategy: 22 | matrix: 23 | php-versions: ["7.4", "8.0", "8.1"] 24 | 25 | name: php-lint 26 | 27 | steps: 28 | - name: Checkout 29 | uses: actions/checkout@v2 30 | 31 | - name: Set up php ${{ matrix.php-versions }} 32 | uses: shivammathur/setup-php@v2 33 | with: 34 | php-version: ${{ matrix.php-versions }} 35 | coverage: none 36 | 37 | - name: Lint 38 | run: composer run lint 39 | 40 | summary: 41 | runs-on: ubuntu-latest 42 | needs: php-lint 43 | 44 | if: always() 45 | 46 | name: php-lint-summary 47 | 48 | steps: 49 | - name: Summary status 50 | run: if ${{ needs.php-lint.result != 'success' && needs.php-lint.result != 'skipped' }}; then exit 1; fi 51 | 52 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "nextcloud/integration_homeassistant", 3 | "description": "A dashboard widget for a home-assistant instance", 4 | "type": "project", 5 | "license": "AGPL-3.0-or-later", 6 | "authors": [ 7 | { 8 | "name": "Poulou" 9 | } 10 | ], 11 | "require-dev": { 12 | "phpunit/phpunit": "^9", 13 | "sabre/dav": "^4.1", 14 | "sabre/xml": "^2.2", 15 | "symfony/event-dispatcher": "^5.3.11", 16 | "psalm/phar": "^5.18", 17 | "nextcloud/coding-standard": "^1.0", 18 | "nextcloud/ocp": "^27.1" 19 | }, 20 | "scripts": { 21 | "lint": "find . -name \\*.php -not -path './vendor/*' -print0 | xargs -0 -n1 php -l", 22 | "cs:check": "php-cs-fixer fix --dry-run --diff", 23 | "cs:fix": "php-cs-fixer fix", 24 | "psalm": "psalm.phar --threads=1", 25 | "psalm:update-baseline": "psalm.phar --threads=1 --update-baseline", 26 | "psalm:update-baseline:force": "psalm.phar --threads=1 --update-baseline --set-baseline=tests/psalm-baseline.xml", 27 | "psalm:clear": "psalm.phar --clear-cache && psalm --clear-global-cache", 28 | "psalm:fix": "psalm.phar --alter --issues=InvalidReturnType,InvalidNullableReturnType,MissingParamType,InvalidFalsableReturnType" 29 | }, 30 | "config": { 31 | "allow-plugins": { 32 | "composer/package-versions-deprecated": true 33 | }, 34 | "platform": { 35 | "php": "7.4" 36 | } 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /.github/workflows/lint-eslint.yml: -------------------------------------------------------------------------------- 1 | # This workflow is provided via the organization template repository 2 | # 3 | # https://github.com/nextcloud/.github 4 | # https://docs.github.com/en/actions/learn-github-actions/sharing-workflows-with-your-organization 5 | # SPDX-FileCopyrightText: Nextcloud contributors 6 | # SPDX-License-Identifier: AGPL-3.0-or-later 7 | 8 | name: Lint 9 | 10 | on: 11 | pull_request: 12 | push: 13 | branches: 14 | - main 15 | - master 16 | - stable* 17 | 18 | jobs: 19 | lint: 20 | runs-on: ubuntu-latest 21 | 22 | name: eslint 23 | 24 | steps: 25 | - name: Checkout 26 | uses: actions/checkout@v3 27 | 28 | - name: Read package.json node and npm engines version 29 | uses: skjnldsv/read-package-engines-version-actions@v1.2 30 | id: versions 31 | with: 32 | fallbackNode: '^12' 33 | fallbackNpm: '^6' 34 | 35 | - name: Set up node ${{ steps.versions.outputs.nodeVersion }} 36 | uses: actions/setup-node@v3 37 | with: 38 | node-version: ${{ steps.versions.outputs.nodeVersion }} 39 | 40 | - name: Set up npm ${{ steps.versions.outputs.npmVersion }} 41 | run: npm i -g npm@"${{ steps.versions.outputs.npmVersion }}" 42 | 43 | - name: Install dependencies 44 | run: npm ci 45 | 46 | - name: Lint 47 | run: npm run lint 48 | -------------------------------------------------------------------------------- /.github/workflows/lint-stylelint.yml: -------------------------------------------------------------------------------- 1 | # This workflow is provided via the organization template repository 2 | # 3 | # https://github.com/nextcloud/.github 4 | # https://docs.github.com/en/actions/learn-github-actions/sharing-workflows-with-your-organization 5 | # SPDX-FileCopyrightText: Nextcloud contributors 6 | # SPDX-License-Identifier: AGPL-3.0-or-later 7 | 8 | name: Lint 9 | 10 | on: 11 | pull_request: 12 | push: 13 | branches: 14 | - main 15 | - master 16 | - stable* 17 | 18 | jobs: 19 | lint: 20 | runs-on: ubuntu-latest 21 | 22 | name: stylelint 23 | 24 | steps: 25 | - name: Checkout 26 | uses: actions/checkout@v2 27 | 28 | - name: Read package.json node and npm engines version 29 | uses: skjnldsv/read-package-engines-version-actions@v1.1 30 | id: versions 31 | with: 32 | fallbackNode: '^12' 33 | fallbackNpm: '^6' 34 | 35 | - name: Set up node ${{ steps.versions.outputs.nodeVersion }} 36 | uses: actions/setup-node@v2 37 | with: 38 | node-version: ${{ steps.versions.outputs.nodeVersion }} 39 | 40 | - name: Set up npm ${{ steps.versions.outputs.npmVersion }} 41 | run: npm i -g npm@"${{ steps.versions.outputs.npmVersion }}" 42 | 43 | - name: Install dependencies 44 | run: npm ci 45 | 46 | - name: Lint 47 | run: npm run stylelint 48 | -------------------------------------------------------------------------------- /lib/Service/HassIntegrationService.php: -------------------------------------------------------------------------------- 1 | config = $config; 18 | $this->clientService = $clientService; 19 | } 20 | 21 | public function post(string $path, array $payload) 22 | { 23 | $baseURL = $this->config->getAppValue(Application::APP_ID, 'base_url', ''); 24 | if (substr($baseURL, -1) == '/') { 25 | $baseURL = substr($baseURL, 0, -1); 26 | } 27 | $longLivedAccessToken = $this->config->getAppValue(Application::APP_ID, 'long_lived_access_token', ''); 28 | $longLivedAccessToken = trim($longLivedAccessToken); 29 | 30 | if (!$baseURL || !$longLivedAccessToken) 31 | return []; 32 | 33 | $client = $this->clientService->newClient(); 34 | $response = $client->post($baseURL . '/api' . $path, [ 35 | 'headers' => [ 36 | 'Authorization' => 'Bearer ' . $longLivedAccessToken, 37 | 'Content-Type' => 'application/json', 38 | ], 39 | 'body' => json_encode($payload), 40 | ]); 41 | return [$response->getBody()]; 42 | } 43 | 44 | public function getYamlWidget(): array 45 | { 46 | return [$this->config->getAppValue(Application::APP_ID, 'yaml_widget', '')]; 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /webpack.config.js: -------------------------------------------------------------------------------- 1 | // SPDX-FileCopyrightText: Poulou 2 | // SPDX-License-Identifier: AGPL-3.0-or-later 3 | const path = require('path') 4 | // we extend the Nextcloud webpack config 5 | const webpackConfig = require('@nextcloud/webpack-vue-config') 6 | // this is to enable eslint and stylelint during compilation 7 | const ESLintPlugin = require('eslint-webpack-plugin') 8 | const StyleLintPlugin = require('stylelint-webpack-plugin') 9 | 10 | const buildMode = process.env.NODE_ENV 11 | const isDev = buildMode === 'development' 12 | webpackConfig.devtool = isDev ? 'cheap-source-map' : 'source-map' 13 | 14 | webpackConfig.stats = { 15 | colors: true, 16 | modules: false, 17 | } 18 | 19 | const appId = 'integration_homeassistant' 20 | webpackConfig.entry = { 21 | templateWidget: { import: path.join(__dirname, 'src', 'templateWidget.js'), filename: appId + '-templateWidget.js' }, 22 | yamlWidget: { import: path.join(__dirname, 'src', 'yamlWidget.js'), filename: appId + '-yamlWidget.js' }, 23 | adminSettings: { import: path.join(__dirname, 'src', 'admin-settings.js'), filename: 'admin-settings.js' }, 24 | } 25 | 26 | // this enables eslint and stylelint during compilation 27 | webpackConfig.plugins.push( 28 | new ESLintPlugin({ 29 | extensions: ['js', 'vue'], 30 | files: 'src', 31 | failOnError: !isDev, 32 | }) 33 | ) 34 | webpackConfig.plugins.push( 35 | new StyleLintPlugin({ 36 | files: 'src/**/*.{css,scss,vue}', 37 | failOnError: !isDev, 38 | }), 39 | ) 40 | 41 | module.exports = webpackConfig 42 | -------------------------------------------------------------------------------- /css/admin-settings.css: -------------------------------------------------------------------------------- 1 | #integration_homeassistant.section h2 { 2 | margin-bottom: 0; 3 | } 4 | 5 | #integration_homeassistant label:not(.inline) { 6 | display: block; 7 | } 8 | 9 | #integration_homeassistant input, 10 | #integration_homeassistant textarea { 11 | width: 100%; 12 | max-width: 400px; 13 | } 14 | 15 | #integration_homeassistant textarea { 16 | min-height: 120px; 17 | font-family: Consolas, Monaco, Lucida Console, Liberation Mono, DejaVu Sans Mono, Bitstream Vera Sans Mono, Courier New, monospace; 18 | } 19 | 20 | #integration_homeassistant .widget-section textarea { 21 | max-width: none; 22 | min-height: 300px; 23 | } 24 | 25 | 26 | #integration_homeassistant .widget-section input[type=checkbox] { 27 | width: 20px; 28 | display: inline-block; 29 | vertical-align: middle; 30 | height: auto; 31 | margin-inline-start: 5px; 32 | } 33 | 34 | 35 | #integration_homeassistant li { 36 | list-style: circle; 37 | margin-inline-start: 15px; 38 | } 39 | 40 | #integration_homeassistant .icon { 41 | vertical-align: text-bottom; 42 | } 43 | 44 | /* Style tabs */ 45 | .tablinks.active, 46 | .tablinks.active:active, 47 | .tablinks.active:hover, 48 | .tablinks.active:focus { 49 | background-color: var(--color-primary-element); 50 | color: var(--color-primary-element-text); 51 | } 52 | 53 | .tab { 54 | overflow: hidden; 55 | } 56 | 57 | .tab button { 58 | display: inline-block; 59 | } 60 | 61 | .tabcontent { 62 | display: none; 63 | padding: 20px 0 64 | } 65 | 66 | .tabcontent#jinja2_widget_tab { 67 | display: block; 68 | } 69 | 70 | #integration_homeassistant a { 71 | color: var(--color-primary-element) 72 | } -------------------------------------------------------------------------------- /appinfo/info.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 8 | integration_homeassistant 9 | Home Assistant integration 10 | A jinja2 template and a YAML widget for a home-assistant instance 11 | 17 | 0.0.7 18 | agpl 19 | Poulou 20 | HassIntegration 21 | dashboard 22 | integration 23 | https://github.com/poulou0/nextcloud-homeassistant-integration 24 | https://github.com/poulou0/nextcloud-homeassistant-integration/issues 25 | https://github.com/poulou0/nextcloud-homeassistant-integration/raw/main/img/screenshot2.jpg 26 | 27 | 28 | 29 | 30 | OCA\HassIntegration\Settings\AdminSettings 31 | OCA\HassIntegration\Sections\HAssAdmin 32 | 33 | 34 | -------------------------------------------------------------------------------- /lib/Listener/AddContentSecurityPolicyListener.php: -------------------------------------------------------------------------------- 1 | config = $config; 24 | } 25 | 26 | /** 27 | * Add domains for websocket connections based on the base_url setting. 28 | * 29 | * @param Event $event 30 | */ 31 | public function handle(Event $event): void 32 | { 33 | if (!($event instanceof AddContentSecurityPolicyEvent)) { 34 | return; 35 | } 36 | 37 | $baseURL = $this->config->getAppValue(Application::APP_ID, 'base_url', ''); 38 | $url = parse_url($baseURL); 39 | 40 | if ($url && isset($url['host'])) { 41 | $hostWithPort = $url['host'] . (isset($url['port']) ? ':' . $url['port'] : ''); 42 | 43 | // Create a new policy instance 44 | $csp = new ContentSecurityPolicy(); 45 | 46 | // Add allowed WebSocket domains to the new policy 47 | $csp->addAllowedFrameDomain('\'self\''); 48 | $csp->addAllowedFrameAncestorDomain('\'self\''); 49 | $csp->addAllowedConnectDomain('ws://' . $hostWithPort); 50 | $csp->addAllowedConnectDomain('wss://' . $hostWithPort); 51 | 52 | // Add the new policy to the event 53 | $event->addPolicy($csp); 54 | } 55 | } 56 | } 57 | -------------------------------------------------------------------------------- /lib/Controller/HassIntegrationController.php: -------------------------------------------------------------------------------- 1 | config = $config; 21 | $this->hassIntegrationService = $hassIntegrationService; 22 | } 23 | 24 | /** 25 | * @NoAdminRequired 26 | * @NoCSRFRequired 27 | * 28 | * @return DataResponse 29 | */ 30 | public function templatePost() 31 | { 32 | $template = $this->config->getAppValue(Application::APP_ID, 'template_widget', ''); 33 | return new DataResponse($this->hassIntegrationService->post('/template', [ 34 | "template" => $template 35 | ])); 36 | } 37 | 38 | /** 39 | * @NoAdminRequired 40 | * @NoCSRFRequired 41 | * 42 | * @return DataResponse 43 | */ 44 | public function togglePost() 45 | { 46 | $entityId = $this->request->getParam("entity_id"); 47 | $pathPart = str_contains($entityId, 'switch') ? 'switch' : 'light'; 48 | return new DataResponse($this->hassIntegrationService->post("/services/{$pathPart}/toggle", [ 49 | "entity_id" => $entityId 50 | ])); 51 | } 52 | 53 | /** 54 | * @NoAdminRequired 55 | * @NoCSRFRequired 56 | * 57 | * @return DataResponse 58 | */ 59 | public function runScriptPost() 60 | { 61 | $entityId = $this->request->getParam("entity_id"); 62 | $scriptName = str_replace("script.", "", $entityId); 63 | return new DataResponse($this->hassIntegrationService->post("/services/script/{$scriptName}", [])); 64 | } 65 | } 66 | -------------------------------------------------------------------------------- /lib/Settings/AdminSettings.php: -------------------------------------------------------------------------------- 1 | config = $config; 17 | } 18 | 19 | /** 20 | * @return TemplateResponse 21 | */ 22 | public function getForm() 23 | { 24 | return new TemplateResponse(Application::APP_ID, 'admin-settings', [ 25 | 'base_url' => $this->config->getAppValue(Application::APP_ID, 'base_url', ''), 26 | 'long_lived_access_token' => $this->config->getAppValue(Application::APP_ID, 'long_lived_access_token', ''), 27 | 'template_widget_title' => $this->config->getAppValue(Application::APP_ID, 'template_widget_title', ''), 28 | 'template_widget_refresh_interval' => $this->config->getAppValue(Application::APP_ID, 'template_widget_refresh_interval', 30), 29 | 'template_widget' => $this->config->getAppValue(Application::APP_ID, 'template_widget', ''), 30 | 'yaml_widget_title' => $this->config->getAppValue(Application::APP_ID, 'yaml_widget_title', ''), 31 | 'yaml_widget' => $this->config->getAppValue(Application::APP_ID, 'yaml_widget', ''), 32 | 'yaml_widget_websockets_enabled' => $this->config->getAppValue(Application::APP_ID, 'yaml_widget_websockets_enabled', 'true'), 33 | ], ''); 34 | } 35 | 36 | public function getSection() 37 | { 38 | return HAssAdmin::SETTINGS_SECTION; // Name of the previously created section. 39 | } 40 | 41 | /** 42 | * @return int whether the form should be rather on the top or bottom of 43 | * the admin section. The forms are arranged in ascending order of the 44 | * priority values. It is required to return a value between 0 and 100. 45 | * 46 | * E.g.: 70 47 | */ 48 | public function getPriority() 49 | { 50 | return 70; 51 | } 52 | } 53 | -------------------------------------------------------------------------------- /lib/Dashboard/YamlWidget.php: -------------------------------------------------------------------------------- 1 | l10n = $l10n; 27 | $this->hassIntegrationService = $hassIntegrationService; 28 | $this->config = $config; 29 | $this->initialStateService = $initialStateService; 30 | } 31 | 32 | public function getId(): string 33 | { 34 | return 'hass-yaml-widget'; 35 | } 36 | public function getTitle(): string 37 | { 38 | $title = $this->config->getAppValue(Application::APP_ID, 'yaml_widget_title', ''); 39 | if (!$title) 40 | $title = 'YAML widget (beta)'; 41 | return $this->l10n->t($title); 42 | } 43 | public function getOrder(): int 44 | { 45 | return 11; 46 | } 47 | public function getIconClass(): string 48 | { 49 | return 'icon-hasswidget'; 50 | } 51 | public function getUrl(): ?string 52 | { 53 | return null; 54 | } 55 | 56 | public function load(): void 57 | { 58 | Util::addScript(Application::APP_ID, Application::APP_ID . '-yamlWidget'); 59 | Util::addStyle(Application::APP_ID, 'dashboard'); 60 | 61 | $this->initialStateService->provideInitialState('dashboard-yaml-widget', $this->getItems()[0]); 62 | 63 | $webSocketsEnabled = $this->config->getAppValue(Application::APP_ID, 'yaml_widget_websockets_enabled', 'true'); 64 | $this->initialStateService->provideInitialState('dashboard-yaml-widget-websockets-enabled', $webSocketsEnabled); 65 | } 66 | 67 | public function getItems(string $userId = null, ?string $since = null, int $limit = 7): array 68 | { 69 | return $this->hassIntegrationService->getYamlWidget(); 70 | } 71 | } 72 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "integration_homeassistant", 3 | "description": "A dashboard widget for a home-assistant instance", 4 | "version": "0.0.7", 5 | "author": "Poulou ", 6 | "contributors": [], 7 | "bugs": { 8 | "url": "https://github.com/poulou0/nextcloud-homeassistant-integration.git" 9 | }, 10 | "license": "agpl", 11 | "private": true, 12 | "scripts": { 13 | "build": "webpack --node-env production --progress", 14 | "dev": "webpack --node-env development --progress", 15 | "watch": "webpack --node-env development --progress --watch", 16 | "serve": "webpack --node-env development serve --progress", 17 | "lint": "eslint --ext .js,.vue src", 18 | "lint:fix": "eslint --ext .js,.vue src --fix", 19 | "stylelint": "stylelint css/*.css css/*.scss src/**/*.scss src/**/*.vue", 20 | "stylelint:fix": "stylelint css/*.css css/*.scss src/**/*.scss src/**/*.vue --fix" 21 | }, 22 | "dependencies": { 23 | "@nextcloud/axios": "^2.3.0", 24 | "@nextcloud/dialogs": "^6.2.0", 25 | "@nextcloud/initial-state": "^2.0.0", 26 | "@nextcloud/password-confirmation": "^5.0.1", 27 | "@nextcloud/router": "^3.0.1", 28 | "home-assistant-js-websocket": "^9.3.0", 29 | "yaml": "^2.4.2" 30 | }, 31 | "browserslist": [ 32 | "extends @nextcloud/browserslist-config" 33 | ], 34 | "engines": { 35 | "node": "^16.0.0", 36 | "npm": "^7.0.0 || ^8.0.0" 37 | }, 38 | "devDependencies": { 39 | "@babel/core": "^7.21.4", 40 | "@nextcloud/babel-config": "^1.0.0", 41 | "@nextcloud/browserslist-config": "^3.0.0", 42 | "@nextcloud/eslint-config": "^8.2.1", 43 | "@nextcloud/eslint-plugin": "^2.0.0", 44 | "@nextcloud/stylelint-config": "^3.0.1", 45 | "@nextcloud/webpack-vue-config": "^5.5.1", 46 | "babel-loader": "^9.2.1", 47 | "eslint": "^8.57.1", 48 | "eslint-plugin-import": "^2.27.5", 49 | "eslint-plugin-jsdoc": "^46.10.1", 50 | "eslint-plugin-n": "^16.6.0", 51 | "eslint-plugin-vue": "^9.11.0", 52 | "eslint-webpack-plugin": "^4.0.1", 53 | "stylelint": "^16.6.0", 54 | "stylelint-webpack-plugin": "^5.0.1", 55 | "vue-loader": "^15.11.1", 56 | "webpack": "^5.79.0", 57 | "webpack-cli": "^5.0.1" 58 | } 59 | } 60 | -------------------------------------------------------------------------------- /css/dashboard.css: -------------------------------------------------------------------------------- 1 | .icon-hasswidget { 2 | background-image: url('../img/logo-dark.svg'); 3 | filter: var(--background-invert-if-dark); 4 | } 5 | 6 | /* 7 | * Switch toggle 8 | * https://www.w3schools.com/howto/tryit.asp?filename=tryhow_css_switch 9 | */ 10 | 11 | .switch { 12 | position: relative; 13 | display: flex; 14 | width: 52px; 15 | height: 16px; 16 | } 17 | 18 | .switch input { 19 | opacity: 0; 20 | width: 0; 21 | height: 0; 22 | } 23 | 24 | .slider { 25 | position: absolute; 26 | cursor: pointer; 27 | top: 0; 28 | inset-inline: 0; 29 | bottom: 0; 30 | background-color: #4c4c4c; 31 | -webkit-transition: .4s; 32 | transition: .4s; 33 | } 34 | 35 | input[disabled]+.slider { 36 | cursor: not-allowed; 37 | background-color: #2e2e2e; 38 | } 39 | 40 | input[disabled]+.slider:before { 41 | background-color: #4b4b4b; 42 | } 43 | 44 | .slider:before { 45 | position: absolute; 46 | content: ""; 47 | height: 26px; 48 | width: 26px; 49 | inset-inline-start: 0; 50 | bottom: 0; 51 | background-color: white; 52 | -webkit-transition: .4s; 53 | transition: .4s; 54 | transform: translateY(5px); 55 | } 56 | 57 | input:checked+.slider { 58 | background-color: #0e6891; 59 | } 60 | 61 | input:checked+.slider:before { 62 | background-color: #03a9f4; 63 | transform: translateX(26px) translateY(5px); 64 | } 65 | 66 | /* Rounded sliders */ 67 | .slider.round { 68 | border-radius: 34px; 69 | } 70 | 71 | .slider.round:before { 72 | border-radius: 50%; 73 | } 74 | 75 | /* 76 | * Yaml widget 77 | */ 78 | 79 | div.panel--content:has(> div[data-id="hass-yaml-widget"]) { 80 | overflow: auto; 81 | } 82 | 83 | .entity-line { 84 | display: flex; 85 | justify-content: space-between; 86 | align-items: center; 87 | margin-bottom: 5px; 88 | } 89 | 90 | .entity-line.entity, 91 | .entity-line.type-section, 92 | .entity-line.type-weblink { 93 | height: 40px; 94 | } 95 | 96 | .entity-line>div:nth-child(1) { 97 | flex: 14; 98 | min-width: 0; 99 | } 100 | 101 | .entity-line>div:nth-child(2) { 102 | flex: 6; 103 | min-width: 0; 104 | display: flex; 105 | justify-content: flex-end; 106 | } 107 | 108 | .entity-line>div>p { 109 | text-overflow: ellipsis; 110 | overflow: hidden; 111 | white-space: nowrap; 112 | } 113 | 114 | .type-section { 115 | font-weight: bold; 116 | } 117 | 118 | .type-weblink a { 119 | color: var(--color-primary-element); 120 | text-decoration: underline; 121 | } -------------------------------------------------------------------------------- /src/admin-settings.js: -------------------------------------------------------------------------------- 1 | import { showSuccess, showError } from '@nextcloud/dialogs' 2 | import { generateOcsUrl } from '@nextcloud/router' 3 | import axios from '@nextcloud/axios' 4 | import { confirmPassword } from '@nextcloud/password-confirmation' 5 | import '@nextcloud/dialogs/style.css' 6 | import '@nextcloud/password-confirmation/style.css' 7 | 8 | document.addEventListener('DOMContentLoaded', function() { 9 | const inputHandler = function(evt) { saveSetting(this.id, this.value) } 10 | document.querySelector('#base_url').addEventListener('change', inputHandler) 11 | document.querySelector('#long_lived_access_token').addEventListener('change', inputHandler) 12 | document.querySelector('#template_widget_title').addEventListener('change', inputHandler) 13 | document.querySelector('#template_widget').addEventListener('change', inputHandler) 14 | document.querySelector('#template_widget_refresh_interval').addEventListener('change', inputHandler) 15 | document.querySelector('#yaml_widget_title').addEventListener('change', inputHandler) 16 | document.querySelector('#yaml_widget').addEventListener('change', inputHandler) 17 | document.querySelector('#yaml_widget_websockets_enabled').addEventListener('change', ({ target: { id, checked } }) => { 18 | saveSetting(id, checked) 19 | }) 20 | 21 | setupTabs() 22 | }) 23 | 24 | /** 25 | * Save a setting by name. 26 | * 27 | * @param {string} key The name/id of the field. 28 | * @param {string} value The value to be set. 29 | * @return {void} 30 | */ 31 | const saveSetting = async (key, value) => { 32 | try { 33 | await confirmPassword() 34 | const url = generateOcsUrl(`/apps/provisioning_api/api/v1/config/apps/integration_homeassistant/${key}`) 35 | await axios.post(url, new URLSearchParams({ value }).toString()) 36 | showSuccess(`Saved '${key}'!`) 37 | } catch (er) { 38 | showError(`Error while saving '${key}'`) 39 | } 40 | } 41 | 42 | /** 43 | * Setup the admin panel tabs. 44 | * 45 | * @return {void} 46 | */ 47 | const setupTabs = () => { 48 | const tablinks = document.querySelectorAll('.tablinks') 49 | const tabcontent = document.querySelectorAll('.tabcontent') 50 | const openTab = (evt, tabId) => { 51 | tablinks.forEach((link) => link.classList.remove('active')) 52 | tabcontent.forEach((content) => { content.style.display = 'none' }) 53 | document.querySelector(`#${tabId}`).style.display = 'block' 54 | evt.currentTarget.classList.add('active') 55 | } 56 | for (let i = 0; i < tablinks.length; i++) { 57 | tablinks[i].addEventListener('click', function(e) { openTab(e, tablinks[i].dataset.target) }, false) 58 | } 59 | } 60 | -------------------------------------------------------------------------------- /lib/Dashboard/TemplateWidget.php: -------------------------------------------------------------------------------- 1 | l10n = $l10n; 26 | $this->hassIntegrationService = $hassIntegrationService; 27 | $this->config = $config; 28 | $this->initialStateService = $initialStateService; 29 | } 30 | 31 | public function getId(): string { return 'hass-template-widget'; } 32 | public function getTitle(): string { 33 | $title = $this->config->getAppValue(Application::APP_ID, 'template_widget_title', ''); 34 | if (!$title) $title = 'Template widget'; 35 | return $this->l10n->t($title); 36 | } 37 | public function getOrder(): int { return 10; } 38 | public function getIconClass(): string { return 'icon-hasswidget'; } 39 | public function getUrl(): ?string { return null; } 40 | 41 | public function load(): void 42 | { 43 | $baseURL = $this->config->getAppValue(Application::APP_ID, 'base_url', ''); 44 | $this->initialStateService->provideInitialState('dashboard-base-url', $baseURL); 45 | $longLivedAccessToken = $this->config->getAppValue(Application::APP_ID, 'long_lived_access_token', ''); 46 | $this->initialStateService->provideInitialState('dashboard-long-lived-access-token', $longLivedAccessToken); 47 | 48 | $items = $this->getItems(); 49 | $this->initialStateService->provideInitialState('dashboard-template-widget', $items); 50 | $interval = (int) $this->config->getAppValue(Application::APP_ID, 'template_widget_refresh_interval', 30); 51 | $this->initialStateService->provideInitialState('dashboard-template-widget-refresh-interval', $interval); 52 | 53 | Util::addScript(Application::APP_ID, Application::APP_ID . '-templateWidget'); 54 | Util::addStyle(Application::APP_ID, 'dashboard'); 55 | } 56 | 57 | public function getItems(string $userId = null, ?string $since = null, int $limit = 7): array { 58 | $template = $this->config->getAppValue(Application::APP_ID, 'template_widget', ''); 59 | return $this->hassIntegrationService->post('/template', [ 60 | "template" => $template 61 | ]); 62 | } 63 | } 64 | -------------------------------------------------------------------------------- /.github/workflows/phpunit-sqlite.yml: -------------------------------------------------------------------------------- 1 | 2 | # SPDX-FileCopyrightText: Nextcloud contributors 3 | # SPDX-License-Identifier: AGPL-3.0-or-later 4 | name: PHPUnit 5 | 6 | on: 7 | pull_request: 8 | push: 9 | branches: 10 | - main 11 | - master 12 | - stable* 13 | 14 | env: 15 | # Location of the phpunit.xml and phpunit.integration.xml files 16 | PHPUNIT_CONFIG: ./tests/phpunit.xml 17 | PHPUNIT_INTEGRATION_CONFIG: ./tests/phpunit.integration.xml 18 | 19 | jobs: 20 | phpunit-sqlite: 21 | runs-on: ubuntu-latest 22 | 23 | strategy: 24 | matrix: 25 | php-versions: ['8.1'] 26 | server-versions: ['master'] 27 | 28 | steps: 29 | - name: Set app env 30 | run: | 31 | # Split and keep last 32 | echo "APP_NAME=integration_homeassistant" >> $GITHUB_ENV 33 | 34 | - name: Checkout server 35 | uses: actions/checkout@v3 36 | with: 37 | submodules: true 38 | repository: nextcloud/server 39 | ref: ${{ matrix.server-versions }} 40 | 41 | - name: Checkout app 42 | uses: actions/checkout@v3 43 | with: 44 | path: apps/${{ env.APP_NAME }} 45 | 46 | - name: Set up php ${{ matrix.php-versions }} 47 | uses: shivammathur/setup-php@v2 48 | with: 49 | php-version: ${{ matrix.php-versions }} 50 | tools: phpunit 51 | extensions: mbstring, iconv, fileinfo, intl, sqlite, pdo_sqlite 52 | coverage: none 53 | 54 | - name: Set up PHPUnit 55 | working-directory: apps/${{ env.APP_NAME }} 56 | run: composer i 57 | 58 | - name: Set up Nextcloud 59 | env: 60 | DB_PORT: 4444 61 | run: | 62 | mkdir data 63 | ./occ maintenance:install --verbose --database=sqlite --database-name=nextcloud --database-host=127.0.0.1 --database-port=$DB_PORT --database-user=root --database-pass=rootpassword --admin-user admin --admin-pass password 64 | ./occ app:enable ${{ env.APP_NAME }} 65 | 66 | - name: Check PHPUnit config file existence 67 | id: check_phpunit 68 | uses: andstor/file-existence-action@v1 69 | with: 70 | files: apps/${{ env.APP_NAME }}/${{ env.PHPUNIT_CONFIG }} 71 | 72 | - name: PHPUnit 73 | # Only run if phpunit config file exists 74 | if: steps.check_phpunit.outputs.files_exists == 'true' 75 | working-directory: apps/${{ env.APP_NAME }} 76 | run: ./vendor/phpunit/phpunit/phpunit -c ${{ env.PHPUNIT_CONFIG }} 77 | 78 | - name: Check PHPUnit integration config file existence 79 | id: check_integration 80 | uses: andstor/file-existence-action@v1 81 | with: 82 | files: apps/${{ env.APP_NAME }}/${{ env.PHPUNIT_INTEGRATION_CONFIG }} 83 | 84 | - name: Run Nextcloud 85 | # Only run if phpunit integration config file exists 86 | if: steps.check_integration.outputs.files_exists == 'true' 87 | run: php -S localhost:8080 & 88 | 89 | - name: PHPUnit integration 90 | # Only run if phpunit integration config file exists 91 | if: steps.check_integration.outputs.files_exists == 'true' 92 | working-directory: apps/${{ env.APP_NAME }} 93 | run: ./vendor/phpunit/phpunit/phpunit -c ${{ env.PHPUNIT_INTEGRATION_CONFIG }} 94 | 95 | summary: 96 | runs-on: ubuntu-latest 97 | needs: phpunit-sqlite 98 | 99 | if: always() 100 | 101 | name: phpunit-sqlite-summary 102 | 103 | steps: 104 | - name: Summary status 105 | run: if ${{ needs.phpunit-sqlite.result != 'success' }}; then exit 1; fi 106 | 107 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | ![Home Assistant Integration, dasboard widget screenshot](img/screenshot2.jpg) 7 | 8 | # Home Assistant Integration 9 | Home assistant widgets for your nextcloud dashboard. 10 | 11 | | Jinja2 template widget | YAML widget | 12 | | ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | 13 | | [![Jinja2 template widget](img/template_widget-video.jpg)](https://youtu.be/XE_LRTAfVjA) | [![YAML widget](img/yaml_widget-video.jpg)](https://youtu.be/PjWH53rqYe8) | 14 | 15 | ## Development environment 16 | 17 | ### Nextcloud dev 18 | > https://github.com/juliushaertl/nextcloud-docker-dev#simple-master-setup 19 | ```shell 20 | cd ~/Projects 21 | git clone https://github.com/juliushaertl/nextcloud-docker-dev 22 | cd nextcloud-docker-dev 23 | ./bootstrap.sh 24 | docker-compose up nextcloud 25 | ``` 26 | go to `http://nextcloud.local` (`admin:admin` for credentials) 27 | ### App dev 28 | 29 | ```shell 30 | sudo apt install php php-xml php-curl composer 31 | ``` 32 | ```shell 33 | cd ~/Projects/nextcloud-docker-dev 34 | git clone git@github.com:poulou0/nextcloud-homeassistant-integration.git workspace/server/apps-extra/integration_homeassistant/ 35 | cd workspace/server/apps-extra/integration_homeassistant/ 36 | npm install 37 | make 38 | npm run watch 39 | ``` 40 | 41 | ## Publish to App Store 42 | 43 | First get an account for the [App Store](http://apps.nextcloud.com/) then run: 44 | 45 | make && make appstore 46 | 47 | The archive is located in build/artifacts/appstore and can then be uploaded to the App Store. 48 | 49 | Post it here according to the instructions: https://apps.nextcloud.com/developer/apps/releases/new 50 | 51 | ```shell 52 | openssl dgst -sha512 -sign ~/.nextcloud/certificates/integration_homeassistant.key ~/Projects/nextcloud-docker-dev/workspace/server/apps-extra/integration_homeassistant/build/artifacts/appstore/integration_homeassistant.tar.gz | openssl base64 53 | ``` 54 | 55 | ## Building the app 56 | 57 | The app can be built by using the provided Makefile by running: 58 | 59 | make 60 | 61 | This requires the following things to be present: 62 | * make 63 | * which 64 | * tar: for building the archive 65 | * curl: used if phpunit and composer are not installed to fetch them from the web 66 | * npm: for building and testing everything JS, only required if a package.json is placed inside the **js/** folder 67 | 68 | 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.: 69 | 70 | **package.json**: 71 | ```json 72 | "scripts": { 73 | "test": "node node_modules/gulp-cli/bin/gulp.js karma", 74 | "prebuild": "npm install && node_modules/bower/bin/bower install && node_modules/bower/bin/bower update", 75 | "build": "node node_modules/gulp-cli/bin/gulp.js" 76 | } 77 | ``` 78 | 79 | ## Running tests 80 | You can use the provided Makefile to run all tests by using: 81 | 82 | make test 83 | 84 | 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** 85 | 86 | Of course you can also install [PHPUnit](http://phpunit.de/getting-started.html) and use the configurations directly: 87 | 88 | phpunit -c phpunit.xml 89 | 90 | or: 91 | 92 | phpunit -c phpunit.integration.xml 93 | 94 | for integration tests 95 | -------------------------------------------------------------------------------- /.github/workflows/phpunit-oci.yml: -------------------------------------------------------------------------------- 1 | 2 | # SPDX-FileCopyrightText: Nextcloud contributors 3 | # SPDX-License-Identifier: AGPL-3.0-or-later 4 | name: PHPUnit 5 | 6 | on: 7 | pull_request: 8 | push: 9 | branches: 10 | - main 11 | - master 12 | - stable* 13 | 14 | env: 15 | # Location of the phpunit.xml and phpunit.integration.xml files 16 | PHPUNIT_CONFIG: ./tests/phpunit.xml 17 | PHPUNIT_INTEGRATION_CONFIG: ./tests/phpunit.integration.xml 18 | 19 | jobs: 20 | phpunit-oci: 21 | runs-on: ubuntu-latest 22 | 23 | strategy: 24 | matrix: 25 | php-versions: ['8.1'] 26 | server-versions: ['master'] 27 | 28 | services: 29 | oracle: 30 | image: oracleinanutshell/oracle-xe-11g 31 | ports: 32 | - 1521:1521/tcp 33 | 34 | steps: 35 | - name: Set app env 36 | run: | 37 | # Split and keep last 38 | echo "APP_NAME=integration_homeassistant" >> $GITHUB_ENV 39 | 40 | - name: Checkout server 41 | uses: actions/checkout@v3 42 | with: 43 | submodules: true 44 | repository: nextcloud/server 45 | ref: ${{ matrix.server-versions }} 46 | 47 | - name: Checkout app 48 | uses: actions/checkout@v3 49 | with: 50 | path: apps/${{ env.APP_NAME }} 51 | 52 | - name: Set up php ${{ matrix.php-versions }} 53 | uses: shivammathur/setup-php@v2 54 | with: 55 | php-version: ${{ matrix.php-versions }} 56 | extensions: mbstring, fileinfo, intl, sqlite, pdo_sqlite, oci8 57 | tools: phpunit 58 | coverage: none 59 | 60 | - name: Set up PHPUnit 61 | working-directory: apps/${{ env.APP_NAME }} 62 | run: composer i 63 | 64 | - name: Set up Nextcloud 65 | env: 66 | DB_PORT: 1521 67 | run: | 68 | mkdir data 69 | ./occ maintenance:install --verbose --database=oci --database-name=XE --database-host=127.0.0.1 --database-port=$DB_PORT --database-user=system --database-pass=oracle --admin-user admin --admin-pass admin 70 | ./occ app:enable ${{ env.APP_NAME }} 71 | 72 | - name: Check PHPUnit config file existence 73 | id: check_phpunit 74 | uses: andstor/file-existence-action@v1 75 | with: 76 | files: apps/${{ env.APP_NAME }}/${{ env.PHPUNIT_CONFIG }} 77 | 78 | - name: PHPUnit 79 | # Only run if phpunit config file exists 80 | if: steps.check_phpunit.outputs.files_exists == 'true' 81 | working-directory: apps/${{ env.APP_NAME }} 82 | run: ./vendor/phpunit/phpunit/phpunit -c ${{ env.PHPUNIT_CONFIG }} 83 | 84 | - name: Check PHPUnit integration config file existence 85 | id: check_integration 86 | uses: andstor/file-existence-action@v1 87 | with: 88 | files: apps/${{ env.APP_NAME }}/${{ env.PHPUNIT_INTEGRATION_CONFIG }} 89 | 90 | - name: Run Nextcloud 91 | # Only run if phpunit integration config file exists 92 | if: steps.check_integration.outputs.files_exists == 'true' 93 | run: php -S localhost:8080 & 94 | 95 | - name: PHPUnit integration 96 | # Only run if phpunit integration config file exists 97 | if: steps.check_integration.outputs.files_exists == 'true' 98 | working-directory: apps/${{ env.APP_NAME }} 99 | run: ./vendor/phpunit/phpunit/phpunit -c ${{ env.PHPUNIT_INTEGRATION_CONFIG }} 100 | 101 | summary: 102 | runs-on: ubuntu-latest 103 | needs: phpunit-oci 104 | 105 | if: always() 106 | 107 | name: phpunit-oci-summary 108 | 109 | steps: 110 | - name: Summary status 111 | run: if ${{ needs.phpunit-oci.result != 'success' }}; then exit 1; fi 112 | 113 | -------------------------------------------------------------------------------- /.github/workflows/phpunit-pgsql.yml: -------------------------------------------------------------------------------- 1 | 2 | # SPDX-FileCopyrightText: Nextcloud contributors 3 | # SPDX-License-Identifier: AGPL-3.0-or-later 4 | name: PHPUnit 5 | 6 | on: 7 | pull_request: 8 | push: 9 | branches: 10 | - main 11 | - master 12 | - stable* 13 | 14 | env: 15 | # Location of the phpunit.xml and phpunit.integration.xml files 16 | PHPUNIT_CONFIG: ./tests/phpunit.xml 17 | PHPUNIT_INTEGRATION_CONFIG: ./tests/phpunit.integration.xml 18 | 19 | jobs: 20 | phpunit-pgsql: 21 | runs-on: ubuntu-latest 22 | 23 | strategy: 24 | matrix: 25 | php-versions: ['8.1'] 26 | server-versions: ['master'] 27 | 28 | services: 29 | postgres: 30 | image: postgres 31 | ports: 32 | - 4444:5432/tcp 33 | env: 34 | POSTGRES_USER: root 35 | POSTGRES_PASSWORD: rootpassword 36 | POSTGRES_DB: nextcloud 37 | options: --health-cmd pg_isready --health-interval 5s --health-timeout 2s --health-retries 5 38 | 39 | steps: 40 | - name: Set app env 41 | run: | 42 | # Split and keep last 43 | echo "APP_NAME=integration_homeassistant" >> $GITHUB_ENV 44 | 45 | - name: Checkout server 46 | uses: actions/checkout@v3 47 | with: 48 | submodules: true 49 | repository: nextcloud/server 50 | ref: ${{ matrix.server-versions }} 51 | 52 | - name: Checkout app 53 | uses: actions/checkout@v3 54 | with: 55 | path: apps/${{ env.APP_NAME }} 56 | 57 | - name: Set up php ${{ matrix.php-versions }} 58 | uses: shivammathur/setup-php@v2 59 | with: 60 | php-version: ${{ matrix.php-versions }} 61 | tools: phpunit 62 | extensions: mbstring, iconv, fileinfo, intl, pgsql, pdo_pgsql 63 | coverage: none 64 | 65 | - name: Set up PHPUnit 66 | working-directory: apps/${{ env.APP_NAME }} 67 | run: composer i 68 | 69 | - name: Set up Nextcloud 70 | env: 71 | DB_PORT: 4444 72 | run: | 73 | mkdir data 74 | ./occ maintenance:install --verbose --database=pgsql --database-name=nextcloud --database-host=127.0.0.1 --database-port=$DB_PORT --database-user=root --database-pass=rootpassword --admin-user admin --admin-pass password 75 | ./occ app:enable ${{ env.APP_NAME }} 76 | 77 | - name: Check PHPUnit config file existence 78 | id: check_phpunit 79 | uses: andstor/file-existence-action@v1 80 | with: 81 | files: apps/${{ env.APP_NAME }}/${{ env.PHPUNIT_CONFIG }} 82 | 83 | - name: PHPUnit 84 | # Only run if phpunit config file exists 85 | if: steps.check_phpunit.outputs.files_exists == 'true' 86 | working-directory: apps/${{ env.APP_NAME }} 87 | run: ./vendor/phpunit/phpunit/phpunit -c ${{ env.PHPUNIT_CONFIG }} 88 | 89 | - name: Check PHPUnit integration config file existence 90 | id: check_integration 91 | uses: andstor/file-existence-action@v1 92 | with: 93 | files: apps/${{ env.APP_NAME }}/${{ env.PHPUNIT_INTEGRATION_CONFIG }} 94 | 95 | - name: Run Nextcloud 96 | # Only run if phpunit integration config file exists 97 | if: steps.check_integration.outputs.files_exists == 'true' 98 | run: php -S localhost:8080 & 99 | 100 | - name: PHPUnit integration 101 | # Only run if phpunit integration config file exists 102 | if: steps.check_integration.outputs.files_exists == 'true' 103 | working-directory: apps/${{ env.APP_NAME }} 104 | run: ./vendor/phpunit/phpunit/phpunit -c ${{ env.PHPUNIT_INTEGRATION_CONFIG }} 105 | 106 | summary: 107 | runs-on: ubuntu-latest 108 | needs: phpunit-pgsql 109 | 110 | if: always() 111 | 112 | name: phpunit-pgsql-summary 113 | 114 | steps: 115 | - name: Summary status 116 | run: if ${{ needs.phpunit-pgsql.result != 'success' }}; then exit 1; fi 117 | 118 | -------------------------------------------------------------------------------- /.github/workflows/phpunit-mysql.yml: -------------------------------------------------------------------------------- 1 | 2 | # SPDX-FileCopyrightText: Nextcloud contributors 3 | # SPDX-License-Identifier: AGPL-3.0-or-later 4 | name: PHPUnit 5 | 6 | on: 7 | pull_request: 8 | push: 9 | branches: 10 | - main 11 | - master 12 | - stable* 13 | 14 | env: 15 | # Location of the phpunit.xml and phpunit.integration.xml files 16 | PHPUNIT_CONFIG: ./tests/phpunit.xml 17 | PHPUNIT_INTEGRATION_CONFIG: ./tests/phpunit.integration.xml 18 | 19 | jobs: 20 | phpunit-mysql: 21 | runs-on: ubuntu-latest 22 | 23 | strategy: 24 | matrix: 25 | php-versions: ['8.1'] 26 | server-versions: ['master'] 27 | 28 | services: 29 | mysql: 30 | image: mariadb:10.5 31 | ports: 32 | - 4444:3306/tcp 33 | env: 34 | MYSQL_ROOT_PASSWORD: rootpassword 35 | options: --health-cmd="mysqladmin ping" --health-interval 5s --health-timeout 2s --health-retries 5 36 | 37 | steps: 38 | - name: Set app env 39 | run: | 40 | # Split and keep last 41 | echo "APP_NAME=integration_homeassistant" >> $GITHUB_ENV 42 | 43 | - name: Enable ONLY_FULL_GROUP_BY MySQL option 44 | run: | 45 | echo "SET GLOBAL sql_mode=(SELECT CONCAT(@@sql_mode,',ONLY_FULL_GROUP_BY'));" | mysql -h 127.0.0.1 -P 4444 -u root -prootpassword 46 | echo "SELECT @@sql_mode;" | mysql -h 127.0.0.1 -P 4444 -u root -prootpassword 47 | 48 | - name: Checkout server 49 | uses: actions/checkout@v3 50 | with: 51 | submodules: true 52 | repository: nextcloud/server 53 | ref: ${{ matrix.server-versions }} 54 | 55 | - name: Checkout app 56 | uses: actions/checkout@v3 57 | with: 58 | path: apps/${{ env.APP_NAME }} 59 | 60 | - name: Set up php ${{ matrix.php-versions }} 61 | uses: shivammathur/setup-php@v2 62 | with: 63 | php-version: ${{ matrix.php-versions }} 64 | tools: phpunit 65 | extensions: mbstring, iconv, fileinfo, intl, mysql, pdo_mysql 66 | coverage: none 67 | 68 | - name: Set up PHPUnit 69 | working-directory: apps/${{ env.APP_NAME }} 70 | run: composer i 71 | 72 | - name: Set up Nextcloud 73 | env: 74 | DB_PORT: 4444 75 | run: | 76 | mkdir data 77 | ./occ maintenance:install --verbose --database=mysql --database-name=nextcloud --database-host=127.0.0.1 --database-port=$DB_PORT --database-user=root --database-pass=rootpassword --admin-user admin --admin-pass password 78 | ./occ app:enable ${{ env.APP_NAME }} 79 | 80 | - name: Check PHPUnit config file existence 81 | id: check_phpunit 82 | uses: andstor/file-existence-action@v1 83 | with: 84 | files: apps/${{ env.APP_NAME }}/${{ env.PHPUNIT_CONFIG }} 85 | 86 | - name: Run Nextcloud 87 | run: php -S localhost:8080 & 88 | 89 | - name: PHPUnit 90 | # Only run if phpunit config file exists 91 | if: steps.check_phpunit.outputs.files_exists == 'true' 92 | working-directory: apps/${{ env.APP_NAME }} 93 | run: ./vendor/phpunit/phpunit/phpunit -c ${{ env.PHPUNIT_CONFIG }} 94 | 95 | - name: Check PHPUnit integration config file existence 96 | id: check_integration 97 | uses: andstor/file-existence-action@v1 98 | with: 99 | files: apps/${{ env.APP_NAME }}/${{ env.PHPUNIT_INTEGRATION_CONFIG }} 100 | 101 | - name: PHPUnit integration 102 | # Only run if phpunit integration config file exists 103 | if: steps.check_integration.outputs.files_exists == 'true' 104 | working-directory: apps/${{ env.APP_NAME }} 105 | run: ./vendor/phpunit/phpunit/phpunit -c ${{ env.PHPUNIT_INTEGRATION_CONFIG }} 106 | 107 | summary: 108 | runs-on: ubuntu-latest 109 | needs: phpunit-mysql 110 | 111 | if: always() 112 | 113 | name: phpunit-mysql-summary 114 | 115 | steps: 116 | - name: Summary status 117 | run: if ${{ needs.phpunit-mysql.result != 'success' }}; then exit 1; fi 118 | 119 | -------------------------------------------------------------------------------- /src/yamlWidget.js: -------------------------------------------------------------------------------- 1 | import { loadState } from '@nextcloud/initial-state' 2 | import { 3 | createConnection, 4 | subscribeEntities, 5 | createLongLivedTokenAuth, 6 | } from 'home-assistant-js-websocket' 7 | import YAML from 'yaml' 8 | import axios from '@nextcloud/axios' 9 | import { generateUrl } from '@nextcloud/router' 10 | 11 | document.addEventListener('DOMContentLoaded', () => { 12 | OCA.Dashboard.register('hass-yaml-widget', (el, { widget }) => { 13 | const webSocketsEnabled = loadState('integration_homeassistant', 'dashboard-yaml-widget-websockets-enabled') === 'true' 14 | try { 15 | const yamlEntities = YAML.parse(loadState('integration_homeassistant', 'dashboard-yaml-widget')) 16 | if (yamlEntities.type !== 'entities') { 17 | el.innerHTML = 'YAML is not of "type: entities"' 18 | } 19 | Object.values(yamlEntities.entities).forEach(entry => { 20 | if (entry.type === 'divider') { 21 | el.innerHTML += '
' 22 | } if (entry.type === 'section') { 23 | el.innerHTML += `
${entry.label}
` 24 | } if (entry.type === 'weblink') { 25 | el.innerHTML += `
${entry.name}` 26 | } else if (entry.entity) { 27 | const name = entry.name ?? entry.entity 28 | let handler = '' 29 | if (entry.entity.startsWith('light') || entry.entity.startsWith('switch')) { 30 | if (webSocketsEnabled) { 31 | handler = `` 32 | } else { 33 | handler = `` 34 | } 35 | } else if (entry.entity.startsWith('media_player') || entry.entity.startsWith('sensor')) { 36 | handler = ` -    ` 37 | } else if (entry.entity.startsWith('script')) { 38 | handler = `` 39 | } 40 | el.innerHTML += `

${name}

${handler}
` 41 | } 42 | }) 43 | } catch (e) { 44 | el.innerHTML = Object.keys(e).length 45 | ? JSON.stringify(e) 46 | : 'Nothing to show :))

Go to "Administrator settings" > "Home assistant integration" to get started.' 47 | } 48 | 49 | if (!webSocketsEnabled) return 50 | 51 | const url = new URL(loadState('integration_homeassistant', 'dashboard-base-url')) 52 | const auth = createLongLivedTokenAuth( 53 | `${url.protocol}//${url.host}`, 54 | loadState('integration_homeassistant', 'dashboard-long-lived-access-token').trim(), 55 | ) 56 | createConnection({ auth }) 57 | .then((connection) => subscribeEntities(connection, (entities) => { 58 | document.querySelectorAll('[data-entity-id]').forEach(element => { 59 | const entity = entities[element.dataset.entityId] 60 | if (element.tagName === 'INPUT' && element.getAttribute('type') === 'checkbox') { 61 | element.checked = entity?.state === 'on' 62 | element.disabled = entity?.state === 'unavailable' || !entity 63 | } else { 64 | element.innerHTML = entity?.state + ' ' + (entity?.attributes?.unit_of_measurement ?? '') 65 | } 66 | 67 | const nameP = element.closest('div.entity-line').querySelector('p') 68 | const name = nameP.dataset.initName || entity?.attributes?.friendly_name 69 | if (name !== nameP.innerHTML) { 70 | nameP.innerHTML = name 71 | nameP.setAttribute('title', name) 72 | } 73 | }) 74 | })) 75 | .catch(() => { el.innerHTML = 'Cannot connect to websocket server!

' + el.innerHTML }) 76 | }) 77 | }) 78 | 79 | document.addEventListener('click', async (e) => { 80 | if (!e.target.dataset.entityId) return 81 | const { entityId } = e.target.dataset 82 | if (entityId.startsWith('light') || entityId.startsWith('switch')) { 83 | await axios.post(generateUrl('/apps/integration_homeassistant/toggle'), { entity_id: entityId }) 84 | } else if (entityId.startsWith('script')) { 85 | await axios.post(generateUrl('/apps/integration_homeassistant/run_script'), { entity_id: entityId }) 86 | } 87 | }, false) 88 | -------------------------------------------------------------------------------- /templates/admin-settings.php: -------------------------------------------------------------------------------- 1 | 10 | 11 |
12 |

t('Home assistant integration')); ?>

13 | 16 |
17 |
t('Base url')); ?>
18 | 19 |
20 | t('Long-lived access token')); ?> 21 | 23 | 24 | 26 | 27 | 28 |
29 | 30 |
31 |
32 |
33 | 35 | 36 |
37 |
38 | 39 | 41 | 43 | 45 | 46 | 48 |

Templates are rendered using the Jinja2 template engine with some Home Assistant specific extensions.

49 | 59 |
60 |
61 | 62 | 64 |
65 | 67 | /> 68 |
69 | 70 | 72 |
    73 |
  • Home Assistant Entities card very basic card 75 | layout for now 76 |
      77 |
    1. Entities like "light", "switch" and "media" tested and should work
      2. 78 |
    2. Every entity row has to have the key "entity" explicitly set
      3. 79 |
    3. Only the "entities" variable is read for now ("title", "header", "footer" etc have no 80 | impact)
      4. 81 |
    4. From special 83 | rows only "divider", "section" and "weblink" work for now
      5. 84 |
    5. More documentation and tutorials on the app's page
      6. 87 |
    88 |
    • 89 |
90 |
91 |
92 |
-------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: Bernhard Posselt 2 | # SPDX-License-Identifier: AGPL-3.0-or-later 3 | 4 | # Generic Makefile for building and packaging a Nextcloud app which uses npm and 5 | # Composer. 6 | # 7 | # Dependencies: 8 | # * make 9 | # * which 10 | # * curl: used if phpunit and composer are not installed to fetch them from the web 11 | # * tar: for building the archive 12 | # * npm: for building and testing everything JS 13 | # 14 | # If no composer.json is in the app root directory, the Composer step 15 | # will be skipped. The same goes for the package.json which can be located in 16 | # the app root or the js/ directory. 17 | # 18 | # The npm command by launches the npm build script: 19 | # 20 | # npm run build 21 | # 22 | # The npm test command launches the npm test script: 23 | # 24 | # npm run test 25 | # 26 | # The idea behind this is to be completely testing and build tool agnostic. All 27 | # build tools and additional package managers should be installed locally in 28 | # your project, since this won't pollute people's global namespace. 29 | # 30 | # The following npm scripts in your package.json install and update the bower 31 | # and npm dependencies and use gulp as build system (notice how everything is 32 | # run from the node_modules folder): 33 | # 34 | # "scripts": { 35 | # "test": "node node_modules/gulp-cli/bin/gulp.js karma", 36 | # "prebuild": "npm install && node_modules/bower/bin/bower install && node_modules/bower/bin/bower update", 37 | # "build": "node node_modules/gulp-cli/bin/gulp.js" 38 | # }, 39 | 40 | app_name=$(notdir $(CURDIR)) 41 | build_tools_directory=$(CURDIR)/build/tools 42 | source_build_directory=$(CURDIR)/build/artifacts/source 43 | source_package_name=$(source_build_directory)/$(app_name) 44 | appstore_build_directory=$(CURDIR)/build/artifacts/appstore 45 | appstore_package_name=$(appstore_build_directory)/$(app_name) 46 | npm=$(shell which npm 2> /dev/null) 47 | composer=$(shell which composer 2> /dev/null) 48 | 49 | all: build 50 | 51 | # Fetches the PHP and JS dependencies and compiles the JS. If no composer.json 52 | # is present, the composer step is skipped, if no package.json or js/package.json 53 | # is present, the npm step is skipped 54 | .PHONY: build 55 | build: 56 | ifneq (,$(wildcard $(CURDIR)/composer.json)) 57 | make composer 58 | endif 59 | ifneq (,$(wildcard $(CURDIR)/package.json)) 60 | make npm 61 | endif 62 | ifneq (,$(wildcard $(CURDIR)/js/package.json)) 63 | make npm 64 | endif 65 | 66 | # Installs and updates the composer dependencies. If composer is not installed 67 | # a copy is fetched from the web 68 | .PHONY: composer 69 | composer: 70 | ifeq (, $(composer)) 71 | @echo "No composer command available, downloading a copy from the web" 72 | mkdir -p $(build_tools_directory) 73 | curl -sS https://getcomposer.org/installer | php 74 | mv composer.phar $(build_tools_directory) 75 | php $(build_tools_directory)/composer.phar install --prefer-dist 76 | else 77 | composer install --prefer-dist 78 | endif 79 | 80 | # Installs npm dependencies 81 | .PHONY: npm 82 | npm: 83 | ifeq (,$(wildcard $(CURDIR)/package.json)) 84 | cd js && $(npm) run build 85 | else 86 | npm run build 87 | endif 88 | 89 | # Removes the appstore build 90 | .PHONY: clean 91 | clean: 92 | rm -rf ./build 93 | 94 | # Same as clean but also removes dependencies installed by composer, bower and 95 | # npm 96 | .PHONY: distclean 97 | distclean: clean 98 | rm -rf vendor 99 | rm -rf node_modules 100 | rm -rf js/vendor 101 | rm -rf js/node_modules 102 | 103 | # Builds the source and appstore package 104 | .PHONY: dist 105 | dist: 106 | make source 107 | make appstore 108 | 109 | # Builds the source package 110 | .PHONY: source 111 | source: 112 | rm -rf $(source_build_directory) 113 | mkdir -p $(source_build_directory) 114 | tar cvzf $(source_package_name).tar.gz \ 115 | --exclude-vcs \ 116 | --exclude="../$(app_name)/build" \ 117 | --exclude="../$(app_name)/js/node_modules" \ 118 | --exclude="../$(app_name)/node_modules" \ 119 | --exclude="../$(app_name)/*.log" \ 120 | --exclude="../$(app_name)/js/*.log" \ 121 | ../$(app_name) 122 | 123 | # Builds the source package for the app store, ignores php and js tests 124 | .PHONY: appstore 125 | appstore: 126 | rm -rf $(appstore_build_directory) 127 | mkdir -p $(appstore_build_directory) 128 | tar cvzf $(appstore_package_name).tar.gz \ 129 | --exclude-vcs \ 130 | --exclude="../$(app_name)/build" \ 131 | --exclude="../$(app_name)/tests" \ 132 | --exclude="../$(app_name)/Makefile" \ 133 | --exclude="../$(app_name)/*.log" \ 134 | --exclude="../$(app_name)/phpunit*xml" \ 135 | --exclude="../$(app_name)/composer.*" \ 136 | --exclude="../$(app_name)/js/node_modules" \ 137 | --exclude="../$(app_name)/js/tests" \ 138 | --exclude="../$(app_name)/js/test" \ 139 | --exclude="../$(app_name)/js/*.log" \ 140 | --exclude="../$(app_name)/js/package.json" \ 141 | --exclude="../$(app_name)/js/bower.json" \ 142 | --exclude="../$(app_name)/js/karma.*" \ 143 | --exclude="../$(app_name)/js/protractor.*" \ 144 | --exclude="../$(app_name)/package.json" \ 145 | --exclude="../$(app_name)/bower.json" \ 146 | --exclude="../$(app_name)/karma.*" \ 147 | --exclude="../$(app_name)/protractor\.*" \ 148 | --exclude="../$(app_name)/.*" \ 149 | --exclude="../$(app_name)/js/.*" \ 150 | --exclude="../$(app_name)/node_modules" \ 151 | --exclude="../$(app_name)/vendor" \ 152 | --exclude="../$(app_name)/src" \ 153 | --exclude="../$(app_name)/stylelint.config.js" \ 154 | --exclude="../$(app_name)/webpack.config.js" \ 155 | --exclude="../$(app_name)/package-lock.json" \ 156 | ../$(app_name) 157 | 158 | .PHONY: test 159 | test: composer 160 | $(CURDIR)/vendor/phpunit/phpunit/phpunit -c phpunit.xml 161 | $(CURDIR)/vendor/phpunit/phpunit/phpunit -c phpunit.integration.xml 162 | -------------------------------------------------------------------------------- /LICENSES/CC0-1.0.txt: -------------------------------------------------------------------------------- 1 | Creative Commons Legal Code 2 | 3 | CC0 1.0 Universal 4 | 5 | CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE 6 | LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN 7 | ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS 8 | INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES 9 | REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS 10 | PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM 11 | THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED 12 | HEREUNDER. 13 | 14 | Statement of Purpose 15 | 16 | The laws of most jurisdictions throughout the world automatically confer 17 | exclusive Copyright and Related Rights (defined below) upon the creator 18 | and subsequent owner(s) (each and all, an "owner") of an original work of 19 | authorship and/or a database (each, a "Work"). 20 | 21 | Certain owners wish to permanently relinquish those rights to a Work for 22 | the purpose of contributing to a commons of creative, cultural and 23 | scientific works ("Commons") that the public can reliably and without fear 24 | of later claims of infringement build upon, modify, incorporate in other 25 | works, reuse and redistribute as freely as possible in any form whatsoever 26 | and for any purposes, including without limitation commercial purposes. 27 | These owners may contribute to the Commons to promote the ideal of a free 28 | culture and the further production of creative, cultural and scientific 29 | works, or to gain reputation or greater distribution for their Work in 30 | part through the use and efforts of others. 31 | 32 | For these and/or other purposes and motivations, and without any 33 | expectation of additional consideration or compensation, the person 34 | associating CC0 with a Work (the "Affirmer"), to the extent that he or she 35 | is an owner of Copyright and Related Rights in the Work, voluntarily 36 | elects to apply CC0 to the Work and publicly distribute the Work under its 37 | terms, with knowledge of his or her Copyright and Related Rights in the 38 | Work and the meaning and intended legal effect of CC0 on those rights. 39 | 40 | 1. Copyright and Related Rights. A Work made available under CC0 may be 41 | protected by copyright and related or neighboring rights ("Copyright and 42 | Related Rights"). Copyright and Related Rights include, but are not 43 | limited to, the following: 44 | 45 | i. the right to reproduce, adapt, distribute, perform, display, 46 | communicate, and translate a Work; 47 | ii. moral rights retained by the original author(s) and/or performer(s); 48 | iii. publicity and privacy rights pertaining to a person's image or 49 | likeness depicted in a Work; 50 | iv. rights protecting against unfair competition in regards to a Work, 51 | subject to the limitations in paragraph 4(a), below; 52 | v. rights protecting the extraction, dissemination, use and reuse of data 53 | in a Work; 54 | vi. database rights (such as those arising under Directive 96/9/EC of the 55 | European Parliament and of the Council of 11 March 1996 on the legal 56 | protection of databases, and under any national implementation 57 | thereof, including any amended or successor version of such 58 | directive); and 59 | vii. other similar, equivalent or corresponding rights throughout the 60 | world based on applicable law or treaty, and any national 61 | implementations thereof. 62 | 63 | 2. Waiver. To the greatest extent permitted by, but not in contravention 64 | of, applicable law, Affirmer hereby overtly, fully, permanently, 65 | irrevocably and unconditionally waives, abandons, and surrenders all of 66 | Affirmer's Copyright and Related Rights and associated claims and causes 67 | of action, whether now known or unknown (including existing as well as 68 | future claims and causes of action), in the Work (i) in all territories 69 | worldwide, (ii) for the maximum duration provided by applicable law or 70 | treaty (including future time extensions), (iii) in any current or future 71 | medium and for any number of copies, and (iv) for any purpose whatsoever, 72 | including without limitation commercial, advertising or promotional 73 | purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each 74 | member of the public at large and to the detriment of Affirmer's heirs and 75 | successors, fully intending that such Waiver shall not be subject to 76 | revocation, rescission, cancellation, termination, or any other legal or 77 | equitable action to disrupt the quiet enjoyment of the Work by the public 78 | as contemplated by Affirmer's express Statement of Purpose. 79 | 80 | 3. Public License Fallback. Should any part of the Waiver for any reason 81 | be judged legally invalid or ineffective under applicable law, then the 82 | Waiver shall be preserved to the maximum extent permitted taking into 83 | account Affirmer's express Statement of Purpose. In addition, to the 84 | extent the Waiver is so judged Affirmer hereby grants to each affected 85 | person a royalty-free, non transferable, non sublicensable, non exclusive, 86 | irrevocable and unconditional license to exercise Affirmer's Copyright and 87 | Related Rights in the Work (i) in all territories worldwide, (ii) for the 88 | maximum duration provided by applicable law or treaty (including future 89 | time extensions), (iii) in any current or future medium and for any number 90 | of copies, and (iv) for any purpose whatsoever, including without 91 | limitation commercial, advertising or promotional purposes (the 92 | "License"). The License shall be deemed effective as of the date CC0 was 93 | applied by Affirmer to the Work. Should any part of the License for any 94 | reason be judged legally invalid or ineffective under applicable law, such 95 | partial invalidity or ineffectiveness shall not invalidate the remainder 96 | of the License, and in such case Affirmer hereby affirms that he or she 97 | will not (i) exercise any of his or her remaining Copyright and Related 98 | Rights in the Work or (ii) assert any associated claims and causes of 99 | action with respect to the Work, in either case contrary to Affirmer's 100 | express Statement of Purpose. 101 | 102 | 4. Limitations and Disclaimers. 103 | 104 | a. No trademark or patent rights held by Affirmer are waived, abandoned, 105 | surrendered, licensed or otherwise affected by this document. 106 | b. Affirmer offers the Work as-is and makes no representations or 107 | warranties of any kind concerning the Work, express, implied, 108 | statutory or otherwise, including without limitation warranties of 109 | title, merchantability, fitness for a particular purpose, non 110 | infringement, or the absence of latent or other defects, accuracy, or 111 | the present or absence of errors, whether or not discoverable, all to 112 | the greatest extent permissible under applicable law. 113 | c. Affirmer disclaims responsibility for clearing rights of other persons 114 | that may apply to the Work or any use thereof, including without 115 | limitation any person's Copyright and Related Rights in the Work. 116 | Further, Affirmer disclaims responsibility for obtaining any necessary 117 | consents, permissions or other rights required for any use of the 118 | Work. 119 | d. Affirmer understands and acknowledges that Creative Commons is not a 120 | party to this document and has no duty or obligation with respect to 121 | this CC0 or use of the Work. 122 | -------------------------------------------------------------------------------- /img/logo-dark.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | logo-black 5 | Created with Sketch. 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /img/app.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | logo-white 5 | Created with Sketch. 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /LICENSES/AGPL-3.0-or-later.txt: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | 6 | Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for software and other kinds of works, specifically designed to ensure cooperation with the community in the case of network server software. 11 | 12 | The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, our General Public Licenses are intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. 13 | 14 | When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. 15 | 16 | Developers that use our General Public Licenses protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License which gives you legal permission to copy, distribute and/or modify the software. 17 | 18 | A secondary benefit of defending all users' freedom is that improvements made in alternate versions of the program, if they receive widespread use, become available for other developers to incorporate. Many developers of free software are heartened and encouraged by the resulting cooperation. However, in the case of software used on network servers, this result may fail to come about. The GNU General Public License permits making a modified version and letting the public access it on a server without ever releasing its source code to the public. 19 | 20 | The GNU Affero General Public License is designed specifically to ensure that, in such cases, the modified source code becomes available to the community. It requires the operator of a network server to provide the source code of the modified version running there to the users of that server. Therefore, public use of a modified version, on a publicly accessible server, gives the public access to the source code of the modified version. 21 | 22 | An older license, called the Affero General Public License and published by Affero, was designed to accomplish similar goals. This is a different license, not a version of the Affero GPL, but Affero has released a new version of the Affero GPL which permits relicensing under this license. 23 | 24 | The precise terms and conditions for copying, distribution and modification follow. 25 | 26 | TERMS AND CONDITIONS 27 | 28 | 0. Definitions. 29 | 30 | "This License" refers to version 3 of the GNU Affero General Public License. 31 | 32 | "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. 33 | 34 | "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. 35 | 36 | To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. 37 | 38 | A "covered work" means either the unmodified Program or a work based on the Program. 39 | 40 | To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. 41 | 42 | To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. 43 | 44 | An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 45 | 46 | 1. Source Code. 47 | The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. 48 | 49 | A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. 50 | 51 | The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. 52 | 53 | The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those 54 | subprograms and other parts of the work. 55 | 56 | The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. 57 | 58 | The Corresponding Source for a work in source code form is that same work. 59 | 60 | 2. Basic Permissions. 61 | All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. 62 | 63 | You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. 64 | 65 | Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 66 | 67 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 68 | No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. 69 | 70 | When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 71 | 72 | 4. Conveying Verbatim Copies. 73 | You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. 74 | 75 | You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 76 | 77 | 5. Conveying Modified Source Versions. 78 | You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: 79 | 80 | a) The work must carry prominent notices stating that you modified it, and giving a relevant date. 81 | 82 | b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". 83 | 84 | c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. 85 | 86 | d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. 87 | 88 | A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 89 | 90 | 6. Conveying Non-Source Forms. 91 | You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: 92 | 93 | a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. 94 | 95 | b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. 96 | 97 | c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. 98 | 99 | d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. 100 | 101 | e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. 102 | 103 | A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. 104 | 105 | A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. 106 | 107 | "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. 108 | 109 | If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). 110 | 111 | The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. 112 | 113 | Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 114 | 115 | 7. Additional Terms. 116 | "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. 117 | 118 | When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. 119 | 120 | Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: 121 | 122 | a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or 123 | 124 | b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or 125 | 126 | c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or 127 | 128 | d) Limiting the use for publicity purposes of names of licensors or authors of the material; or 129 | 130 | e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or 131 | 132 | f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. 133 | 134 | All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. 135 | 136 | If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. 137 | 138 | Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 139 | 140 | 8. Termination. 141 | 142 | You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). 143 | 144 | However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. 145 | 146 | Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. 147 | 148 | Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 149 | 150 | 9. Acceptance Not Required for Having Copies. 151 | 152 | You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 153 | 154 | 10. Automatic Licensing of Downstream Recipients. 155 | 156 | Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. 157 | 158 | An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. 159 | 160 | You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 161 | 162 | 11. Patents. 163 | 164 | A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". 165 | 166 | A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. 167 | 168 | Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. 169 | 170 | In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. 171 | 172 | If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent 173 | license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. 174 | 175 | If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. 176 | 177 | A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. 178 | 179 | Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 180 | 181 | 12. No Surrender of Others' Freedom. 182 | 183 | If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may 184 | not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 185 | 186 | 13. Remote Network Interaction; Use with the GNU General Public License. 187 | 188 | Notwithstanding any other provision of this License, if you modify the Program, your modified version must prominently offer all users interacting with it remotely through a computer network (if your version supports such interaction) an opportunity to receive the Corresponding Source of your version by providing access to the Corresponding Source from a network server at no charge, through some standard or customary means of facilitating copying of software. This Corresponding Source shall include the Corresponding Source for any work covered by version 3 of the GNU General Public License that is incorporated pursuant to the following paragraph. 189 | 190 | Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the work with which it is combined will remain governed by version 3 of the GNU General Public License. 191 | 192 | 14. Revised Versions of this License. 193 | 194 | The Free Software Foundation may publish revised and/or new versions of the GNU Affero General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. 195 | 196 | Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU Affero General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU Affero General Public License, you may choose any version ever published by the Free Software Foundation. 197 | 198 | If the Program specifies that a proxy can decide which future versions of the GNU Affero General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. 199 | 200 | Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 201 | 202 | 15. Disclaimer of Warranty. 203 | 204 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 205 | 206 | 16. Limitation of Liability. 207 | 208 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 209 | 210 | 17. Interpretation of Sections 15 and 16. 211 | 212 | If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. 213 | 214 | END OF TERMS AND CONDITIONS 215 | 216 | How to Apply These Terms to Your New Programs 217 | 218 | If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. 219 | 220 | To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. 221 | 222 | 223 | Copyright (C) 224 | 225 | 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. 226 | 227 | 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. 228 | 229 | You should have received a copy of the GNU Affero General Public License along with this program. If not, see . 230 | 231 | Also add information on how to contact you by electronic and paper mail. 232 | 233 | If your software can interact with users remotely through a computer network, you should also make sure that it provides a way for users to get its source. For example, if your program is a web application, its interface could display a "Source" link that leads users to an archive of the code. There are many ways you could offer source, and different solutions will be better for different programs; see section 13 for the specific requirements. 234 | 235 | You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU AGPL, see . 236 | --------------------------------------------------------------------------------