diff --git a/.codecov.yml b/.codecov.yml index 76fd209ba..a80e4ee96 100644 --- a/.codecov.yml +++ b/.codecov.yml @@ -9,7 +9,7 @@ coverage: status: project: default: - threshold: 0.5% + threshold: 2.5% patch: off changes: no diff --git a/.editorconfig b/.editorconfig index b978680c1..e49ab5718 100644 --- a/.editorconfig +++ b/.editorconfig @@ -10,6 +10,10 @@ charset = utf-8 indent_style = space indent_size = 4 +[*.twig] +indent_style = space +indent_size = 4 + [*.yaml] indent_style = space indent_size = 4 diff --git a/.env.dist b/.env.dist index 4b785509b..3d69195d9 100644 --- a/.env.dist +++ b/.env.dist @@ -1,16 +1,47 @@ -# Configure your database connection and set the correct server version: -# for MySQL "serverVersion=5.7" and for MariaDB "serverVersion=mariadb-10.5.8" +# +# You should NOT use this file in production, but instead move the environment variables to your webserver configuration. +# The .env file is only existing to simplify the initial setup! +# + +#================================================================================ +# Configure your database connection and set the correct server version. +# +# You have to replace the following values with your defaults: +# - the version "5.7" +# - the database username "user" +# - the database password "password" +# - the database schema name "database" +# - you might have to adapt port "3306" and server IP "127.0.0.1" as well +# +# For MySQL that would be "serverVersion=5.7" as in: +# DATABASE_URL=mysql://user:password@127.0.0.1:3306/database?charset=utf8&serverVersion=5.7 +# +# For MariaDB it would be "serverVersion=mariadb-10.5.8": +# DATABASE_URL=mysql://user:password@127.0.0.1:3306/database?charset=utf8&serverVersion=mariadb-10.5.8 +# DATABASE_URL=mysql://user:password@127.0.0.1:3306/database?charset=utf8&serverVersion=5.7 -# Email will be sent with this address as sender + +#================================================================================ +# The full documentation can be found at https://www.kimai.org/documentation/emails.html +# +# Email will be sent with this address as sender: MAILER_FROM=kimai@example.com -# Email connection (disabled by default) more info at https://www.kimai.org/documentation/emails.html +# Email connection (disabled by default) - see documentation for the format MAILER_URL=null://null + +#================================================================================ # do not change, unless you are developing for Kimai APP_ENV=prod -# should be changed to a unique character sequence + +#================================================================================ +# should be changed to a unique character sequence, used for hashing cookies APP_SECRET=change_this_to_something_unique -# unlikely, that you need to change this one -CORS_ALLOW_ORIGIN=^https?://localhost(:[0-9]+)?$ -# Running behind reverse proxies? Use those: + +#================================================================================ +# Running behind reverse proxies? Try these: # TRUSTED_PROXIES=127.0.0.1,127.0.0.2 # TRUSTED_HOSTS=localhost,example.com + +#================================================================================ +# unlikely, that you need to change this one +CORS_ALLOW_ORIGIN=^https?://localhost(:[0-9]+)?$ diff --git a/.eslintrc.js b/.eslintrc.js new file mode 100644 index 000000000..a1752cbd0 --- /dev/null +++ b/.eslintrc.js @@ -0,0 +1,11 @@ +module.exports = { + env: { + "browser": true, + "node": true, + "es6": true, + "amd": true, + }, + parser: '@babel/eslint-parser', + extends: ['eslint:recommended'], + ignorePatterns: ["assets/*.js"], +} \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 6f77cae28..5f1397afe 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -10,8 +10,8 @@ body: id: what-happened attributes: label: Describe the issue - description: A clear and concise description of the problem you are facing. - placeholder: Tell us what you see! + description: "A clear and concise description of the problem you are facing. Is that a browser issue? Then add device information: Ubuntu 20.04 with Brave 1.46, Windows 10 with Chrome 85, iPhone 10, Mac with Safari 16" + placeholder: Tell us what you see! Include the steps necessary to reproduce the behavior (e.g. go to, scroll down and click here ...) validations: required: true - type: checkboxes @@ -30,21 +30,8 @@ body: id: version attributes: label: Kimai version - description: Which version of Kimai are you running (check Doctor or About screen) - placeholder: 1.xx.x - validations: - required: true - - type: dropdown - id: php - attributes: - label: Which PHP version are you using? - options: - - "7.3" - - "7.4" - - "8.0" - - "8.1" - - "8.2" - - Other (please mention below) + description: Which version of Kimai are you running (see Doctor/About/Kimai-Cloud screen) + placeholder: 1.xx.x or 2.xx.x validations: required: true - type: dropdown @@ -52,23 +39,32 @@ body: attributes: label: How do you run Kimai? options: - - kimai.cloud service - - Self-Hosted + - Virtual Server or alike + - KIMAI CLOUD + - Docker - Synology + - Plesk + - Shared-Hosting + - Other (please mention below) + validations: + required: true + - type: dropdown + id: php + attributes: + label: Which PHP version are you using? + options: + - "8.1" + - Unknown + - "8.2" + - "8.0" + - "7.4" + - "7.3" - Other (please mention below) validations: required: true - - type: textarea - id: reproducer - attributes: - label: Steps to reproduce the behavior - value: | - 1. Go to '...' - 2. Scroll down to '...' - 3. Click on '...' - 4. See error - type: textarea id: logs + render: Text attributes: label: Logfile description: Please paste the last lines from your logfile at "var/log/prod.log" or "Doctor > Logs", around the time when the problem happened. @@ -77,11 +73,4 @@ body: attributes: label: Screenshots description: If applicable, add screenshots to better explain your problem. - - type: textarea - id: additional - attributes: - label: Additional context - description: Add any other context about the problem here. - value: | - Device: [Ubuntu Laptop 16 inch, Windows Desktop 27 inch, iPhone 6s] - Browser [e.g. Firefox 81, Chrome 85, Safari 14] + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f90f12fa9..63d3f0aa7 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -9,4 +9,4 @@ A clear and concise description of what this pull request adds or changes. ## Checklist - [ ] I verified that my code applies to the guidelines (`composer code-check`) - [ ] I updated the documentation (see [here](https://github.com/kimai/www.kimai.org/tree/master/_documentation)) -- [ ] I agree that this code is used in Kimai and will be published under the [MIT license](https://github.com/kimai/kimai/blob/master/LICENSE) +- [ ] I agree that this code is used in Kimai (see [license](https://github.com/kimai/kimai/blob/main/LICENSE)) diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml index db5e48a3d..be816fbad 100644 --- a/.github/release-drafter.yml +++ b/.github/release-drafter.yml @@ -36,11 +36,10 @@ template: | [Upgrade Kimai](https://www.kimai.org/documentation/updates.html) - [Install Kimai](https://www.kimai.org/documentation/installation.html) - [Docker](https://tobybatch.github.io/kimai2/) **PHP Version compatibility:** - - PHP 7.3 is [end-of-life](https://www.php.net/supported-versions.php) - - PHP 7.4 is [end-of-life](https://www.php.net/supported-versions.php) in a few days! + - PHP 7.3 and PHP 7.4 are [end-of-life](https://www.php.net/supported-versions.php) - PHP 8.0 and PHP 8.1 are supported - - **Next release will be PHP 8 ONLY, as [announced one year ago](https://www.kimai.org/blog/2021/sunsetting-php-7/).** + + A feature freeze is in place and only bugfix releases will be published for 1.30.x. Next major release will be in the 2.x series (PHP >= 8.1, Symfony 6, Tabler UI, see #2902). $CHANGES diff --git a/.github/workflows/coverage.yaml b/.github/workflows/coverage.yaml deleted file mode 100644 index 108fba0cb..000000000 --- a/.github/workflows/coverage.yaml +++ /dev/null @@ -1,69 +0,0 @@ -name: Coverage -on: - pull_request: null - push: - branches: - - master -jobs: - tests: - runs-on: ubuntu-latest - services: - mysql: - image: mysql:5.7 - env: - MYSQL_ALLOW_EMPTY_PASSWORD: false - MYSQL_ROOT_PASSWORD: kimai - MYSQL_DATABASE: kimai - ports: - - 3306/tcp - options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3 - strategy: - matrix: - php: ['8.0'] - - name: Coverage (${{ matrix.php }}) - steps: - - - name: Clone Kimai - uses: actions/checkout@v2 - - - name: Setup PHP - uses: shivammathur/setup-php@v2 - with: - php-version: ${{ matrix.php }} - coverage: pcov - extensions: mbstring, xml, ctype, iconv, intl, mysql, zip, gd, ldap - - - name: Determine composer cache directory - id: composer-cache - run: "echo \"::set-output name=directory::$(composer config cache-dir)\"" - - - name: Cache Composer dependencies - uses: actions/cache@v2 - with: - path: "${{ steps.composer-cache.outputs.directory }}" - key: ${{ runner.os }}-${{ matrix.php }}-${{ hashFiles('**/composer.lock') }} - - - name: Install dependencies - run: composer install - - - name: Install LDAP package - run: composer require laminas/laminas-ldap - - - name: Setup problem matchers for PHPUnit - run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json" - - - name: Run tests - run: vendor/bin/phpunit tests/ --coverage-clover=coverage.xml - env: - DATABASE_URL: mysql://root:kimai@127.0.0.1:${{ job.services.mysql.ports['3306'] }}/kimai?serverVersion=5.7 - APP_ENV: dev - MAILER_URL: null://localhost - TEST_WITH_BUNDLES: 1 - - - name: Upload code coverage - uses: codecov/codecov-action@v2 - with: - token: ${{ secrets.CODECOV_TOKEN }} - files: ./coverage.xml - fail_ci_if_error: true diff --git a/.github/workflows/docker.yaml b/.github/workflows/docker.yaml index 76d8a048e..30dfc7004 100644 --- a/.github/workflows/docker.yaml +++ b/.github/workflows/docker.yaml @@ -5,13 +5,12 @@ on: jobs: build: - name: Dispatch release event to tobybatch + name: Trigger docker image build runs-on: ubuntu-latest steps: - name: Emit repository_dispatch - uses: mvasigh/dispatch-action@1.1.6 + uses: peter-evans/repository-dispatch@v2 with: token: ${{ secrets.DOCKER_ACCESS_TOKEN }} - repo: kimai2 - owner: tobybatch + repository: tobybatch/kimai2 event_type: kimai_release diff --git a/.github/workflows/lockfiles.yaml b/.github/workflows/lockfiles.yaml index 22ed9e717..3b81455d4 100644 --- a/.github/workflows/lockfiles.yaml +++ b/.github/workflows/lockfiles.yaml @@ -3,7 +3,7 @@ on: pull_request: null push: branches: - - master + - main jobs: lockfiles: runs-on: ubuntu-latest @@ -11,7 +11,9 @@ jobs: steps: - name: Clone Kimai - uses: actions/checkout@v2 + uses: actions/checkout@v3 + with: + persist-credentials: false - name: Prevent file change uses: xalvarez/prevent-file-change-action@v1 diff --git a/.github/workflows/release-drafter.yaml b/.github/workflows/release-drafter.yaml index e4db341c6..7174435cf 100644 --- a/.github/workflows/release-drafter.yaml +++ b/.github/workflows/release-drafter.yaml @@ -3,7 +3,7 @@ name: Release Drafter on: push: branches: - - master + - main permissions: contents: read diff --git a/.github/workflows/testing.yaml b/.github/workflows/testing.yaml index e7b24cbbc..5e8004bea 100644 --- a/.github/workflows/testing.yaml +++ b/.github/workflows/testing.yaml @@ -3,13 +3,13 @@ on: pull_request: null push: branches: - - master + - main jobs: integration: runs-on: ubuntu-latest services: mysql: - image: mysql:5.7 + image: mysql:latest env: MYSQL_ALLOW_EMPTY_PASSWORD: false MYSQL_ROOT_PASSWORD: kimai @@ -19,30 +19,34 @@ jobs: options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3 strategy: matrix: - php: ['7.4', '8.0', '8.1'] + php: ['8.1', '8.2'] name: Integration (${{ matrix.php }}) steps: - name: Clone Kimai - uses: actions/checkout@v2 + uses: actions/checkout@v3 + with: + persist-credentials: false - name: Setup PHP uses: shivammathur/setup-php@v2 with: php-version: ${{ matrix.php }} - coverage: none - extensions: mbstring, xml, ctype, iconv, intl, mysql, zip, gd, ldap - tools: cs2pr:1.1.0, symfony-cli + coverage: pcov + extensions: ctype, gd, iconv, intl, ldap, mbstring, mysql, xml, zip + tools: cs2pr, symfony-cli + env: + fail-fast: true - name: Determine composer cache directory id: composer-cache - run: "echo \"::set-output name=directory::$(composer config cache-dir)\"" + run: echo "composer_cache_directory=$(composer config cache-dir)" >> $GITHUB_ENV - name: Cache Composer dependencies - uses: actions/cache@v2 + uses: actions/cache@v3 with: - path: "${{ steps.composer-cache.outputs.directory }}" + path: "${{ env.composer_cache_directory }}" key: ${{ runner.os }}-${{ matrix.php }}-${{ hashFiles('**/composer.lock') }} - name: Install dependencies @@ -51,43 +55,49 @@ jobs: - name: Validate Composer run: composer validate --strict - - name: Warmup cache for PHPStan + - name: Warmup cache run: APP_ENV=dev bin/console kimai:reload -n - name: Check codestyles - run: vendor/bin/php-cs-fixer fix --dry-run --verbose --config=.php-cs-fixer.dist.php --using-cache=no --show-progress=none --format=checkstyle | cs2pr + run: PHP_CS_FIXER_IGNORE_ENV=1 vendor/bin/php-cs-fixer fix --dry-run --verbose --config=.php-cs-fixer.dist.php --using-cache=no --show-progress=none --format=checkstyle | cs2pr - - name: Run PHPStan on Codebase - run: vendor/bin/phpstan analyse src -c phpstan.neon --level=5 --no-progress --error-format=checkstyle | cs2pr + - name: Run PHPStan for application + run: vendor/bin/phpstan analyse -c phpstan.neon --no-progress --error-format=checkstyle | cs2pr - - name: Run PHPStan on Tests - run: vendor/bin/phpstan analyse tests -c tests/phpstan.neon --level=5 --no-progress --error-format=checkstyle | cs2pr + - name: Run PHPStan for tests + run: vendor/bin/phpstan analyse -c tests/phpstan.neon --no-progress --error-format=checkstyle | cs2pr - name: Lint codebase run: composer linting - - name: Check for security issues in packages - run: symfony security:check - - - name: Install LDAP package + - name: Install LDAP package (for tests) run: composer require laminas/laminas-ldap - - name: Setup problem matchers for PHPUnit + - name: Setup problem matchers (for PHPUnit) run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json" - - name: Run unit tests - run: composer kimai:tests-unit + - name: Run quick unit-tests + run: composer tests-unit env: DATABASE_URL: mysql://root:kimai@127.0.0.1:${{ job.services.mysql.ports['3306'] }}/kimai?serverVersion=5.7 APP_ENV: dev MAILER_URL: null://localhost - - name: Run integration tests - run: composer kimai:tests-integration + - name: Full test-suite with coverage + run: vendor/bin/phpunit tests/ --coverage-clover=coverage.xml env: DATABASE_URL: mysql://root:kimai@127.0.0.1:${{ job.services.mysql.ports['3306'] }}/kimai?serverVersion=5.7 APP_ENV: dev MAILER_URL: null://localhost + TEST_WITH_BUNDLES: 1 + + - name: Upload code coverage + if: matrix.php == '8.1' + uses: codecov/codecov-action@v3 + with: + token: ${{ secrets.CODECOV_TOKEN }} + files: ./coverage.xml + fail_ci_if_error: true - name: Run migrations on MySQL run: | @@ -99,3 +109,6 @@ jobs: DATABASE_URL: mysql://root:kimai@127.0.0.1:${{ job.services.mysql.ports['3306'] }}/kimai?serverVersion=5.7 APP_ENV: dev MAILER_URL: null://localhost + + - name: Check for security issues in packages + run: symfony security:check diff --git a/.github_changelog_generator b/.github_changelog_generator deleted file mode 100644 index 871f7d0b4..000000000 --- a/.github_changelog_generator +++ /dev/null @@ -1,5 +0,0 @@ -unreleased=true -future-release=1.20 -exclude-labels=duplicate,support,question,invalid,wontfix,release,waiting for feedback,documentation -enhancement_labels=>feature request,translation,technical debt,documentation -issues-wo-labels=false diff --git a/.gitignore b/.gitignore index 718304479..6f3227606 100644 --- a/.gitignore +++ b/.gitignore @@ -1,12 +1,20 @@ -# ========== KIMAI ========== # some hosters require a htaccess to change the PHP version .htaccess .env-* .idea/ .DS_Store +rector.php +phpstan.sh # for symfony local webserver php.ini +.php-version + +# YARN 2 +.yarnrc.yml +.yarn + +# for keeping empty directories !.gitkeep /bin/* @@ -14,13 +22,10 @@ php.ini *local.yaml /config/bundles-local.php -/public/avatars/*.png - /templates/invoice/renderer/.~lock* /translations/branding.*.xlf /var/data/* -!/var/data/.gitkeep /var/coverage/ /var/cache/* @@ -32,9 +37,11 @@ php.ini /var/plugins/* *.disabled -# ========== KIMAI ========== - ###> symfony/framework-bundle ### +/.env.local +/.env.local.php +/.env.*.local +/config/secrets/prod/prod.decrypt.private.php .env /public/bundles/ /vendor/ diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php index 04807e40f..1fb1680e5 100644 --- a/.php-cs-fixer.dist.php +++ b/.php-cs-fixer.dist.php @@ -22,7 +22,7 @@ $fixer 'line_ending' => true, 'constant_case' => ['case' => 'lower'], 'lowercase_keywords' => true, - 'method_argument_space' => ['on_multiline' => 'ensure_fully_multiline'], + 'method_argument_space' => ['on_multiline' => 'ensure_fully_multiline', 'after_heredoc' => true], 'header_comment' => ['header' => $fileHeaderComment, 'separate' => 'both'], 'no_php4_constructor' => true, 'ordered_imports' => true, @@ -77,8 +77,7 @@ $fixer 'no_short_bool_cast' => true, 'no_singleline_whitespace_before_semicolons' => true, 'no_spaces_around_offset' => true, - 'no_trailing_comma_in_list_call' => true, - 'no_trailing_comma_in_singleline_array' => true, + 'no_trailing_comma_in_singleline' => true, 'no_unneeded_curly_braces' => true, 'no_unneeded_final_method' => true, 'no_unused_imports' => true, @@ -154,6 +153,15 @@ $fixer '@internal' ] ], + 'list_syntax' => ['syntax' => 'short'], + 'assign_null_coalescing_to_coalesce_equal' => true, + 'non_printable_character' => true, + 'octal_notation' => true, + 'heredoc_indentation' => ['indentation' => 'start_plus_one'], + 'no_space_around_double_colon' => true, + 'no_useless_nullsafe_operator' => true, + 'clean_namespace' => true, + 'no_unset_cast' => true, ]) ->setFinder( PhpCsFixer\Finder::create() diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 84a26f3a8..f84164698 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,26 +1,15 @@ # Contributing Kimai is an open source project, contributions made by the community are welcome. -Send your ideas, code reviews, pull requests and feature requests to help improving this project. +Send your ideas, code reviews, pull requests and feature requests to help to improve this project. ## Pull request rules -- Use the [pre-configured codesniffer](.php_cs.dist)) to check for `composer kimai:codestyle` and fix `composer kimai:codestyle-fix` violations -- Add PHPUnit tests for your changes! -- Verify everything still works with `composer kimai:tests-unit` and `composer kimai:tests-integration` -- If you contribute new files, add them with the file-header template from below (the code-style fixer can do that for you) +- Apply our code-style by running `composer codestyle-fix` +- Run the static code analysis with `composer phpstan` +- Verify everything still works with `composer tests-unit` and `composer tests-integration` +- Add tests for your changes - When sending in a PR, you must accept that your contributions/code will be published under MIT license (see the [LICENSE](LICENSE) file as well), otherwise your PR will be closed - If one of the PR checks/builds fails, fix it before asking for a review Further documentation can be found in the [developer documentation](https://www.kimai.org/documentation/developers.html). - -### File-header template -``` -/* - * This file is part of the Kimai time-tracking app. - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ -``` - diff --git a/LICENSE b/LICENSE index 35f38be3b..be3f7b28e 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,661 @@ -MIT License + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 -Copyright (c) 2017-2022 Kevin Papst @ https://www.kevinpapst.de + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: + Preamble -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. + 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. -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. \ No newline at end of file + 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. + + 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. + + 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. + + 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. + + 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. + + 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. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "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. + + 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. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + 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. + + 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. + + 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. + + 1. Source Code. + + 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. + + 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. + + 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. + + 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 +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + 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. + + 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. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + 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. + + 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. + + 4. Conveying Verbatim Copies. + + 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. + + 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. + + 5. Conveying Modified Source Versions. + + 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: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + 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". + + 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. + + 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. + + 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. + + 6. Conveying Non-Source Forms. + + 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: + + 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. + + 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. + + 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. + + 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. + + 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. + + 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. + + 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. + + "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. + + 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). + + 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. + + 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. + + 7. Additional Terms. + + "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. + + 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. + + 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: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + 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 + + 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 + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + 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. + + 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. + + 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. + + 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. + + 8. Termination. + + 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). + + 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. + + 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. + + 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. + + 9. Acceptance Not Required for Having Copies. + + 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. + + 10. Automatic Licensing of Downstream Recipients. + + 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. + + 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. + + 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. + + 11. Patents. + + 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". + + 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. + + 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. + + 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. + + 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 +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. + + 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. + + 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. + + 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. + + 12. No Surrender of Others' Freedom. + + 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 +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. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + 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. + + 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. + + 14. Revised Versions of this License. + + 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. + + 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. + + 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. + + 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. + + 15. Disclaimer of Warranty. + + 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. + + 16. Limitation of Liability. + + 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. + + 17. Interpretation of Sections 15 and 16. + + 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. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + 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. + + 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. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + 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. + + 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 +. diff --git a/README.md b/README.md index 55f211cde..c2fe1ed91 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@

- Kimai logo + Kimai logo

CI Status - Code Coverage - Latest stable version - License + Code Coverage + Latest stable version + License Twitter Mastodon

@@ -16,7 +16,7 @@ Kimai is a free, open source and online time-tracking software designed for small businesses and freelancers. It is built with modern technologies such as [Symfony](https://github.com/symfony/symfony), [Bootstrap](https://github.com/twbs/bootstrap), [RESTful API](https://github.com/FriendsOfSymfony/FOSRestBundle), [Doctrine](https://github.com/doctrine/), -[AdminLTE](https://github.com/kevinpapst/AdminLTEBundle/), [Webpack](https://github.com/webpack/webpack), ES6 and [many](composer.json) [more](package.json). +[Tabler](https://github.com/kevinpapst/TablerBundle/), [Webpack](https://github.com/webpack/webpack), ES6 and [many](composer.json) [more](package.json). ## Introduction @@ -28,7 +28,7 @@ It is built with modern technologies such as [Symfony](https://github.com/symfon ### Requirements -- PHP 7.4, 8.0 or 8.1 +- PHP 8.1 minimum - MariaDB or MySQL - A webserver and subdomain - PHP extensions: `gd`, `intl`, `json`, `mbstring`, `pdo`, `xsl`, `zip` @@ -65,13 +65,8 @@ and so many more. You can see a rough development roadmap in the [Milestones](https://github.com/kimai/kimai/milestones) sections. It is open for changes and input from the community, your [ideas and questions](https://github.com/kimai/kimai/issues) are welcome. -> Kimai uses a rolling release concept for delivering updates. -> You don't have to wait for the next official release, upgrade it at any time from the master branch, -> which is always deployable - release tags are simple snapshots of the development version. - Release versions will be created on a regular basis, every couple of weeks. -Every code change, whether it's a new feature or a bugfix, will be done on the master branch. -Kimai is actively developed in my spare time, I put my effort into the software instead of back-porting changes. +Every code change, whether it's a new feature or a bugfix, will be done on the `main` branch. ## Contributing diff --git a/SECURITY.md b/SECURITY.md index edc48104c..0abcb2fc8 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,11 +2,11 @@ ## Supported Versions -As announced in the [README](README.md) I only support the latest available release and master. +As announced in the [README](README.md) I only support the latest available release and `main` branch. | Version | Supported | |----------------------|--------------------| -| main/master branch | :white_check_mark: | +| main branch | :white_check_mark: | | latest minor release | :white_check_mark: | | older releases | :x: | diff --git a/TODO b/TODO new file mode 100644 index 000000000..5aa624d48 --- /dev/null +++ b/TODO @@ -0,0 +1,36 @@ +=========================================================================== + +INVOICES + +- HTML Rechnungstemplates funktionieren nicht mehr richtig + +=========================================================================== + +THEME + +- Update to latest release und angepasstes CSS entfernen + +- Theme Dark Mode mit Modus "Browser" sollte Standard sein: + https://github.com/tabler/tabler/issues/892#event-5666309557 + +=========================================================================== + +MIXED + +- Alle URLs ändern + - /admin/activity/ zu /activity/ + - /admin/project/ zu /project/ + - /admin/..../ zu /..../ + - /team/timesheet/ zu /timesheets/ + +- Tags => immer Berechtigung prüfen und "create" option über die VIEW ans Javascript geben + => den FormType nur ändern zu "AutoComplete" wenn es mehr als 500 Tags sind + => Übersetzungen (Suche, Erstellen, Keine Ergebnisse) über data attribute ans JS durchreichen + +=========================================================================== + +MIGRATIONS + +- rename 2.0 migration once it will be released + +=========================================================================== diff --git a/UPGRADING.md b/UPGRADING.md index ad35d9f67..1fc2f499e 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -1,4 +1,4 @@ -# Upgrading Kimai 2 +# Upgrading Kimai _Make sure to create a backup before you start!_ @@ -8,12 +8,44 @@ you can upgrade your Kimai installation to the latest stable release. Check below if there are more version specific steps required, which need to be executed after the normal update process. Perform EACH version specific task between your version and the new one, otherwise you risk data inconsistency or a broken installation. +## [2.0](https://github.com/kevinpapst/kimai2/releases/tag/2.0) + +**!! This release requires minimum PHP version to 8.1 !!** + +Developer read the full documentation at [https://www.kimai.org/documentation/migration-v2.html](https://www.kimai.org/documentation/migration-v2.html). + +- Invoice renderer and templates for XML, JSON and TEXT were moved to the [Extended invoicing plugin](https://www.kimai.org/store/invoice-bundle.html) (install if you use one of those) +- Moved `company.docx` to [external repo](https://github.com/kimai/invoice-templates/tree/main/docx-company) (needs to be re-uploaded if you want to keep on using it!) +- Role names are forced to be uppercase +- Removed unused `public/avatars/` directory +- `local.yaml` is not compatible with old version, remove it before the update and then re-create it after everything works + - dashboard default config + - removed: theme.branding.translation + - removed: kimai.plugin_dir +- Time-tracking mode `duration_only` was removed, existing installations will be switched to `default` +- Removed Twig filters. You might have to replace them in your custom export/invoice templates: + - `date_full` => `date_time` + - `duration_decimal` => `duration(true)` + - `currency` => `currency_name` + - `country` => `country_name` + - `language` => `language_name` +- Removed support for custom translation files (use [TranslationBundle](https://www.kimai.org/store/translation-bundle.html) instead or write your own plugin) +- Removed all 3rd party mailer packages, you need to install them manually (ONLY if you used a short syntax to configure the `MAILER_URL` in `.env`): + - `composer require symfony/amazon-mailer` + - `composer require symfony/google-mailer` + - `composer require symfony/mailchimp-mailer` + - `composer require symfony/mailgun-mailer` + - `composer require symfony/postmark-mailer` + - `composer require symfony/sendgrid-mailer` ## [1.16](https://github.com/kimai/kimai/releases/tag/1.16) +If you are using MariaDB, it must be at least version 10.1, older versions are not supported any longer. + **DEVELOPER** - Removed `formDateTime` field from API model `I18nConfig` +- Upgraded to Doctrine DBAL 3, see [docs](https://github.com/doctrine/dbal/blob/3.1.x/UPGRADE.md) - you might have to update your bundle ## [1.15](https://github.com/kimai/kimai/releases/tag/1.15) diff --git a/assets/app.js b/assets/app.js index 01f176bd3..8f7381508 100644 --- a/assets/app.js +++ b/assets/app.js @@ -1,96 +1,3 @@ -// ------------------- INLINED ADMIN-LTE DEFINITIONS ------------------- -// require('../vendor/kevinpapst/adminlte-bundle/Resources/assets/admin-lte'); -// this was replaced to save around 300kb by: -// - removing moment locales which are not used -// - removing fullcalendar locales which are not used -// - removing icheck which is not used -// - removing jquery-ui which is not used - -const $ = require('jquery'); -global.$ = global.jQuery = $; - -require('bootstrap-sass'); -require('jquery-slimscroll'); - -require('select2'); -require('select2/dist/js/i18n/ar'); -require('select2/dist/js/i18n/cs'); -require('select2/dist/js/i18n/da'); -require('select2/dist/js/i18n/de'); -require('select2/dist/js/i18n/el'); -require('select2/dist/js/i18n/es'); -require('select2/dist/js/i18n/eu'); -require('select2/dist/js/i18n/fa'); -require('select2/dist/js/i18n/fi'); -require('select2/dist/js/i18n/fr'); -require('select2/dist/js/i18n/he'); -require('select2/dist/js/i18n/hr'); -require('select2/dist/js/i18n/hu'); -require('select2/dist/js/i18n/it'); -require('select2/dist/js/i18n/ja'); -require('select2/dist/js/i18n/ko'); -require('select2/dist/js/i18n/nb'); -require('select2/dist/js/i18n/nl'); -require('select2/dist/js/i18n/pl'); -require('select2/dist/js/i18n/pt'); -require('select2/dist/js/i18n/pt-BR'); -require('select2/dist/js/i18n/ro'); -require('select2/dist/js/i18n/ru'); -require('select2/dist/js/i18n/sk'); -require('select2/dist/js/i18n/sv'); -require('select2/dist/js/i18n/tr'); -require('select2/dist/js/i18n/vi'); -require('select2/dist/js/i18n/zh-CN'); - -const Moment = require('moment'); -global.moment = Moment; -require('moment/locale/ar'); -require('moment/locale/cs'); -require('moment/locale/da'); -require('moment/locale/de'); -require('moment/locale/de-at'); -require('moment/locale/de-ch'); -require('moment/locale/el'); -require('moment/locale/eo'); -require('moment/locale/es'); -require('moment/locale/eu'); -require('moment/locale/fa'); -require('moment/locale/fi'); -require('moment/locale/fo'); -require('moment/locale/fr'); -require('moment/locale/he'); -require('moment/locale/hr'); -require('moment/locale/hu'); -require('moment/locale/it'); -require('moment/locale/ja'); -require('moment/locale/ko'); -require('moment/locale/nb'); -require('moment/locale/nl'); -require('moment/locale/pl'); -require('moment/locale/pt'); -require('moment/locale/pt-br'); -require('moment/locale/ro'); -require('moment/locale/ru'); -require('moment/locale/sk'); -require('moment/locale/sv'); -require('moment/locale/tr'); -require('moment/locale/vi'); -require('moment/locale/zh-cn'); - -require('daterangepicker'); - -// ------ AdminLTE framework ------ -require('./sass/bootstrap.scss'); -require('./sass/fontawesome.scss'); -require('admin-lte/dist/css/AdminLTE.min.css'); -require('admin-lte/dist/css/skins/_all-skins.css'); -require('../vendor/kevinpapst/adminlte-bundle/Resources/assets/admin-lte-extensions.scss'); - -global.$.AdminLTE = {}; -global.$.AdminLTE.options = {}; -require('admin-lte/dist/js/adminlte.min'); -// ------------------- INLINED ADMIN-LTE DEFINITIONS ------------------- -// --------------------------------------------------------------------- require('./sass/app.scss'); @@ -98,8 +5,5 @@ require('./sass/app.scss'); require('./js/KimaiWebLoader.js'); global.KimaiPaginatedBoxWidget = require('./js/widgets/KimaiPaginatedBoxWidget').default; global.KimaiReloadPageWidget = require('./js/widgets/KimaiReloadPageWidget').default; -global.KimaiCookies = require('./js/widgets/KimaiCookies').default; +global.KimaiColor = require('./js/widgets/KimaiColor').default; global.KimaiStorage = require('./js/widgets/KimaiStorage').default; - -// ------ Autocomplete for tags only ------ -require('jquery-ui/ui/widgets/autocomplete'); diff --git a/assets/calendar.js b/assets/calendar.js index 155f5a97a..f4e1360f8 100644 --- a/assets/calendar.js +++ b/assets/calendar.js @@ -1,40 +1,2 @@ -// can be removed, once fullcalendar was updated and works without draggable jquery ui objects -require('jquery-ui/ui/widgets/draggable'); - -require('fullcalendar'); -require('fullcalendar/dist/gcal.min'); - -require('fullcalendar/dist/locale/ar'); -require('fullcalendar/dist/locale/cs'); -require('fullcalendar/dist/locale/da'); -require('fullcalendar/dist/locale/de'); -require('fullcalendar/dist/locale/de-at'); -require('fullcalendar/dist/locale/de-ch'); -require('fullcalendar/dist/locale/el'); -require('fullcalendar/dist/locale/es'); -require('fullcalendar/dist/locale/eu'); -require('fullcalendar/dist/locale/fa'); -require('fullcalendar/dist/locale/fi'); -require('fullcalendar/dist/locale/fr'); -require('fullcalendar/dist/locale/he'); -require('fullcalendar/dist/locale/hr'); -require('fullcalendar/dist/locale/hu'); -require('fullcalendar/dist/locale/it'); -require('fullcalendar/dist/locale/ja'); -require('fullcalendar/dist/locale/ko'); -require('fullcalendar/dist/locale/nb'); -require('fullcalendar/dist/locale/nl'); -require('fullcalendar/dist/locale/pl'); -require('fullcalendar/dist/locale/pt'); -require('fullcalendar/dist/locale/pt-br'); -require('fullcalendar/dist/locale/ro'); -require('fullcalendar/dist/locale/ru'); -require('fullcalendar/dist/locale/sk'); -require('fullcalendar/dist/locale/sv'); -require('fullcalendar/dist/locale/tr'); -require('fullcalendar/dist/locale/zh-cn'); -require('fullcalendar/dist/locale/vi'); -require('fullcalendar/dist/locale/en-gb'); // the last imported file is used as fallback for locales that do not exist (like EO) - -require('fullcalendar/dist/fullcalendar.min.css'); +global.KimaiCalendar = require('./js/widgets/KimaiCalendar').default; diff --git a/assets/chart.js b/assets/chart.js index ef9370d8e..472d27602 100644 --- a/assets/chart.js +++ b/assets/chart.js @@ -1,2 +1,56 @@ +import { + Chart, + ArcElement, + LineElement, + BarElement, + PointElement, + BarController, +// BubbleController, + DoughnutController, + LineController, + PieController, +// PolarAreaController, +// RadarController, +// ScatterController, + CategoryScale, + LinearScale, +// LogarithmicScale, +// RadialLinearScale, +// TimeScale, +// TimeSeriesScale, +// Decimation, +// Filler, + Legend, + Title, + Tooltip, +// SubTitle +} from 'chart.js'; -require('chart.js/dist/Chart.min'); +Chart.register( + ArcElement, + LineElement, + BarElement, + PointElement, + BarController, +// BubbleController, + DoughnutController, + LineController, + PieController, +// PolarAreaController, +// RadarController, +// ScatterController, + CategoryScale, + LinearScale, +// LogarithmicScale, +// RadialLinearScale, +// TimeScale, +// TimeSeriesScale, +// Decimation, +// Filler, + Legend, + Title, + Tooltip, +// SubTitle +); + +global.Chart = Chart; \ No newline at end of file diff --git a/assets/dashboard.js b/assets/dashboard.js new file mode 100644 index 000000000..3930f7667 --- /dev/null +++ b/assets/dashboard.js @@ -0,0 +1,8 @@ +/** + * https://gridstackjs.com + * https://github.com/gridstack/gridstack.js/tree/master/doc + */ +require('gridstack/dist/gridstack.min.css'); +require('gridstack/dist/gridstack-extra.min.css'); +import { GridStack } from 'gridstack'; +global.GridStack = GridStack; \ No newline at end of file diff --git a/assets/export-pdf.js b/assets/export-pdf.js new file mode 100644 index 000000000..d11ead44b --- /dev/null +++ b/assets/export-pdf.js @@ -0,0 +1,2 @@ + +require('./sass/export-pdf.scss'); diff --git a/assets/images/default_avatar.png b/assets/images/default_avatar.png deleted file mode 100644 index 277c9f781..000000000 Binary files a/assets/images/default_avatar.png and /dev/null differ diff --git a/assets/images/signature.png b/assets/images/signature.png deleted file mode 100644 index e6e1ffafa..000000000 Binary files a/assets/images/signature.png and /dev/null differ diff --git a/assets/js/KimaiConfiguration.js b/assets/js/KimaiConfiguration.js index 05548b91e..1dd7f75dc 100644 --- a/assets/js/KimaiConfiguration.js +++ b/assets/js/KimaiConfiguration.js @@ -23,4 +23,31 @@ export default class KimaiConfiguration { return name in this._configurations; } + isRTL() { + return this.get('direction') === 'rtl'; + } + + getLanguage() { + return this.get('locale').replace('_', '-'); + } + + is24Hours() { + return !!this.get('twentyFourHours'); + } + + /** + * @param {boolean} iso + * @return {number} + */ + getFirstDayOfWeek(iso = true) { + if (iso === undefined) { + iso = true; + } + let config = this.get('first_dow_iso'); + if (!iso) { + config = config % 7; + } + return config; + } + } diff --git a/assets/js/KimaiContainer.js b/assets/js/KimaiContainer.js index 821f52338..2f65b461d 100644 --- a/assets/js/KimaiContainer.js +++ b/assets/js/KimaiContainer.js @@ -20,8 +20,8 @@ export default class KimaiContainer { /** * Create a new Container with the given configurations and translations. * - * @param {Object} configuration - * @param {Object} translation + * @param {KimaiConfiguration} configuration + * @param {KimaiTranslation} translation */ constructor(configuration, translation) { if (!(configuration instanceof KimaiConfiguration)) { diff --git a/assets/js/KimaiLoader.js b/assets/js/KimaiLoader.js index 037fc00c1..82562221f 100644 --- a/assets/js/KimaiLoader.js +++ b/assets/js/KimaiLoader.js @@ -9,19 +9,16 @@ * [KIMAI] KimaiLoader: bootstrap the application and all plugins */ -import moment from 'moment'; +import { Settings } from 'luxon'; import KimaiTranslation from "./KimaiTranslation"; import KimaiConfiguration from "./KimaiConfiguration"; import KimaiContainer from "./KimaiContainer"; -import KimaiActiveRecordsDuration from './plugins/KimaiActiveRecordsDuration.js'; import KimaiDatatableColumnView from './plugins/KimaiDatatableColumnView.js'; import KimaiThemeInitializer from "./plugins/KimaiThemeInitializer"; -import KimaiDateRangePicker from "./plugins/KimaiDateRangePicker"; +import KimaiDateRangePicker from "./forms/KimaiDateRangePicker"; import KimaiDatatable from "./plugins/KimaiDatatable"; import KimaiToolbar from "./plugins/KimaiToolbar"; import KimaiAPI from "./plugins/KimaiAPI"; -import KimaiSelectDataAPI from "./plugins/KimaiSelectDataAPI"; -import KimaiDateTimePicker from "./plugins/KimaiDateTimePicker"; import KimaiAlternativeLinks from "./plugins/KimaiAlternativeLinks"; import KimaiAjaxModalForm from "./plugins/KimaiAjaxModalForm"; import KimaiActiveRecords from "./plugins/KimaiActiveRecords"; @@ -29,60 +26,76 @@ import KimaiRecentActivities from "./plugins/KimaiRecentActivities"; import KimaiEvent from "./plugins/KimaiEvent"; import KimaiAPILink from "./plugins/KimaiAPILink"; import KimaiAlert from "./plugins/KimaiAlert"; -import KimaiAutocomplete from "./plugins/KimaiAutocomplete"; -import KimaiFormSelect from "./plugins/KimaiFormSelect"; +import KimaiAutocomplete from "./forms/KimaiAutocomplete"; +import KimaiFormSelect from "./forms/KimaiFormSelect"; import KimaiForm from "./plugins/KimaiForm"; -import KimaiDatePicker from "./plugins/KimaiDatePicker"; +import KimaiDatePicker from "./forms/KimaiDatePicker"; import KimaiConfirmationLink from "./plugins/KimaiConfirmationLink"; import KimaiMultiUpdateTable from "./plugins/KimaiMultiUpdateTable"; import KimaiDateUtils from "./plugins/KimaiDateUtils"; import KimaiEscape from "./plugins/KimaiEscape"; +import KimaiFetch from "./plugins/KimaiFetch"; +import KimaiTimesheetForm from "./forms/KimaiTimesheetForm"; +import KimaiTeamForm from "./forms/KimaiTeamForm"; +import KimaiCopyDataForm from "./forms/KimaiCopyDataForm"; +import KimaiDateNowForm from "./forms/KimaiDateNowForm"; +import KimaiNotification from "./plugins/KimaiNotification"; +import KimaiHotkeys from "./plugins/KimaiHotkeys"; export default class KimaiLoader { constructor(configurations, translations) { // set the current locale for all javascript components - moment.locale(configurations['locale'].replace('_', '-').toLowerCase()); + Settings.defaultLocale = configurations['locale'].replace('_', '-').toLowerCase(); + Settings.defaultZone = configurations['timezone']; const kimai = new KimaiContainer( new KimaiConfiguration(configurations), new KimaiTranslation(translations) ); + // GLOBAL HELPER PLUGINS kimai.registerPlugin(new KimaiEscape()); kimai.registerPlugin(new KimaiEvent()); kimai.registerPlugin(new KimaiAPI()); kimai.registerPlugin(new KimaiAlert()); + kimai.registerPlugin(new KimaiFetch()); kimai.registerPlugin(new KimaiDateUtils()); - kimai.registerPlugin(new KimaiFormSelect('.selectpicker')); + kimai.registerPlugin(new KimaiNotification()); + + // FORM PLUGINS + kimai.registerPlugin(new KimaiFormSelect('.selectpicker', 'select[data-related-select]')); + kimai.registerPlugin(new KimaiDateRangePicker('input[data-daterangepicker="on"]')); + kimai.registerPlugin(new KimaiDatePicker('input[data-datepicker="on"]')); + kimai.registerPlugin(new KimaiAutocomplete()); + kimai.registerPlugin(new KimaiTimesheetForm()); + kimai.registerPlugin(new KimaiTeamForm()); + kimai.registerPlugin(new KimaiCopyDataForm()); + kimai.registerPlugin(new KimaiDateNowForm()); + kimai.registerPlugin(new KimaiForm()); + kimai.registerPlugin(new KimaiHotkeys()); + + // SPECIAL FEATURES kimai.registerPlugin(new KimaiConfirmationLink('confirmation-link')); - kimai.registerPlugin(new KimaiActiveRecordsDuration()); kimai.registerPlugin(new KimaiDatatableColumnView('data-column-visibility')); - kimai.registerPlugin(new KimaiDateRangePicker('input[data-daterangepickerenable="on"]')); - kimai.registerPlugin(new KimaiDateTimePicker('input[data-datetimepicker="on"]')); - kimai.registerPlugin(new KimaiDatePicker('input[data-datepickerenable="on"]')); kimai.registerPlugin(new KimaiDatatable('section.content', 'table.dataTable')); kimai.registerPlugin(new KimaiToolbar('form.searchform', 'toolbar-action')); - kimai.registerPlugin(new KimaiSelectDataAPI('select[data-related-select]')); kimai.registerPlugin(new KimaiAlternativeLinks('.alternative-link')); kimai.registerPlugin(new KimaiAjaxModalForm('.modal-ajax-form')); - kimai.registerPlugin(new KimaiRecentActivities('li.notifications-menu')); - kimai.registerPlugin(new KimaiActiveRecords('li.messages-menu', 'li.messages-menu-empty')); + kimai.registerPlugin(new KimaiRecentActivities()); + kimai.registerPlugin(new KimaiActiveRecords('header .messages-menu', 'header .messages-menu-empty')); kimai.registerPlugin(new KimaiAPILink('api-link')); - kimai.registerPlugin(new KimaiAutocomplete('.js-autocomplete')); - kimai.registerPlugin(new KimaiForm()); - kimai.registerPlugin(new KimaiThemeInitializer()); kimai.registerPlugin(new KimaiMultiUpdateTable()); - //kimai.registerPlugin(new KimaiPauseRecord('li.messages-menu ul.menu li')); + kimai.registerPlugin(new KimaiThemeInitializer()); // notify all listeners that Kimai plugins can now be registered - kimai.getPlugin('event').trigger('kimai.pluginRegister', {'kimai': kimai}); + document.dispatchEvent(new CustomEvent('kimai.pluginRegister', {detail: {'kimai': kimai}})); // initialize all plugins kimai.getPlugins().map(plugin => { plugin.init(); }); // notify all listeners that Kimai is now ready to be used - kimai.getPlugin('event').trigger('kimai.initialized', {'kimai': kimai}); + document.dispatchEvent(new CustomEvent('kimai.initialized', {detail: {'kimai': kimai}})); this.kimai = kimai; } diff --git a/assets/js/KimaiPlugin.js b/assets/js/KimaiPlugin.js index 2f357341c..b9cacf922 100644 --- a/assets/js/KimaiPlugin.js +++ b/assets/js/KimaiPlugin.js @@ -58,6 +58,20 @@ export default class KimaiPlugin { return this.getContainer().getConfiguration().get(name); } + /** + * @return {KimaiConfiguration} + */ + getConfigurations() { + return this.getContainer().getConfiguration(); + } + + /** + * @returns {KimaiDateUtils} + */ + getDateUtils() { + return this.getPlugin('date'); + } + /** * @param {string} name * @returns {KimaiPlugin} @@ -66,11 +80,82 @@ export default class KimaiPlugin { return this.getContainer().getPlugin(name); } + /** + * @returns {KimaiTranslation} + */ + getTranslation() { + return this.getContainer().getTranslation(); + } + + /** + * @param {string} name + * @returns {string} + */ + translate(name) { + return this.getTranslation().get(name); + } + /** * @param {string} title * @returns {string} */ escape(title) { return this.getPlugin('escape').escapeForHtml(title); - }; + } + + /** + * @param {string} name + * @param {string|null} details + */ + trigger(name, details = null) { + this.getPlugin('event').trigger(name, details); + } + + /** + * @param {string} url + * @param {object} options + * @returns {Promise} + */ + fetch(url, options = {}) { + return this.getPlugin('fetch').fetch(url, options); + } + + /** + * @param {HTMLFormElement} form + * @param {object} options + * @param {string|null} url + * @returns {Promise} + */ + fetchForm(form, options = {}, url = null) { + url = url || form.getAttribute('action'); + const method = form.getAttribute('method').toUpperCase(); + + if (method === 'GET') { + const data = this.getPlugin('form').convertFormDataToQueryString(form, {}, true); + // TODO const data = new URLSearchParams(new FormData(form)).toString(); + url = url + (url.includes('?') ? '&' : '?') + data; + options = {...{method: 'GET'}, ...options}; + } else if (method === 'POST') { + options = {...{ + method: 'POST', + body: new FormData(form) + }, ...options}; + } + + return this.fetch(url, options); + } + + /** + * Check if the current device is a mobile device (targeting the bootstrip xs breakpoint size). + * + * @returns {boolean} + */ + isMobile() { + const width = Math.max( + document.documentElement.clientWidth, + window.innerWidth || 0 + ) + + return width < 576; + } } diff --git a/assets/js/forms/KimaiAutocomplete.js b/assets/js/forms/KimaiAutocomplete.js new file mode 100644 index 000000000..973a11c1c --- /dev/null +++ b/assets/js/forms/KimaiAutocomplete.js @@ -0,0 +1,97 @@ +/* + * This file is part of the Kimai time-tracking app. + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +import TomSelect from 'tom-select'; +import KimaiFormPlugin from "./KimaiFormPlugin"; + +/** + * Supporting auto-complete fields via API. + * Used for timesheet tagging in toolbar and edit dialogs. + */ +export default class KimaiAutocomplete extends KimaiFormPlugin { + + init() + { + this.selector = '[data-form-widget="autocomplete"]'; + } + + /** + * @param {HTMLFormElement} form + * @return boolean + */ + supportsForm(form) // eslint-disable-line no-unused-vars + { + return true; + } + + activateForm(form) + { + /** @type {KimaiAPI} API */ + const API = this.getContainer().getPlugin('api'); + + [].slice.call(form.querySelectorAll(this.selector)).map((node) => { + const apiUrl = node.dataset['autocompleteUrl']; + let minChars = 3; + if (node.dataset['minimumCharacter'] !== undefined) { + minChars = parseInt(node.dataset['minimumCharacter']); + } + + new TomSelect(node, { + // if there are more than 500, they need to be found by "typing" + maxOptions: 500, + // the autocomplete is ONLY used, when the user can create tags + create: node.dataset['create'] !== undefined, + onOptionAdd: (value) => { + node.dispatchEvent(new CustomEvent('create', {detail: {'value': value}})); + }, + plugins: ['remove_button'], + shouldLoad: function(query) { + return query.length >= minChars; + }, + load: (query, callback) => { + API.get(apiUrl, {'name': query}, (data) => { + const results = [].slice.call(data).map((result) => { + return {text: result, value: result}; + }); + callback(results); + }, () => { + callback(); + }); + }, + render: { + // eslint-disable-next-line + not_loading: (data, escape) => { + // no default content + }, + option_create: (data, escape) => { + const name = escape(data.input); + if (name.length < 3) { + return null; + } + const tpl = this.translate('select.search.create'); + const tplReplaced = tpl.replace('%input%', '' + name + '') + return '
' + tplReplaced + '
'; + }, + no_results: (data, escape) => { + const tpl = this.translate('select.search.notfound'); + const tplReplaced = tpl.replace('%input%', '' + escape(data.input) + '') + return '
' + tplReplaced + '
'; + }, + }, + }); + }); + } + + destroyForm(form) { + [].slice.call(form.querySelectorAll(this.selector)).map((node) => { + if (node.tomselect) { + node.tomselect.destroy(); + } + }); + } + +} diff --git a/assets/js/forms/KimaiCopyDataForm.js b/assets/js/forms/KimaiCopyDataForm.js new file mode 100644 index 000000000..d9ba66869 --- /dev/null +++ b/assets/js/forms/KimaiCopyDataForm.js @@ -0,0 +1,71 @@ +/* + * This file is part of the Kimai time-tracking app. + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +/*! + * [KIMAI] KimaiEditTimesheetForm: responsible for the most important form in the application + */ + +import KimaiFormPlugin from "./KimaiFormPlugin"; + +/** + * Used for simple copy from link to input action, e.g. the time and duration dropdowns + * copy the selected values into their corresponding input. + */ +export default class KimaiCopyDataForm extends KimaiFormPlugin { + + /** + * @param {HTMLFormElement} form + * @return boolean + */ + supportsForm(form) // eslint-disable-line no-unused-vars + { + return true; + } + + /** + * @param {HTMLFormElement} form + */ + activateForm(form) // eslint-disable-line no-unused-vars + { + if (this._eventHandler === undefined) { + this._eventHandler = (event) => { + let element = event.target; + if (!element.matches('a[data-form-widget="copy-data"]')) { + element = element.parentNode; // mostly for icons + } + if (!element.matches('a[data-form-widget="copy-data"]') || element.dataset.target === undefined) { + return; + } + const target = document.querySelector(element.dataset.target); + if (target === null) { + return; + } + target.value = element.dataset.value; + if (element.dataset.event !== undefined) { + for (const event of element.dataset.event.split(' ')) { + target.dispatchEvent(new Event(event)); + } + } else if (element.dataset.eventBubbles !== undefined) { + for (const event of element.dataset.eventBubbles.split(' ')) { + target.dispatchEvent(new Event(event, {bubbles: true})); + } + } + event.preventDefault(); + }; + } + form.addEventListener('click', this._eventHandler); + } + + /** + * @param {HTMLFormElement} form + */ + destroyForm(form) // eslint-disable-line no-unused-vars + { + form.removeEventListener('click', this._eventHandler); + } + +} diff --git a/assets/js/forms/KimaiDateNowForm.js b/assets/js/forms/KimaiDateNowForm.js new file mode 100644 index 000000000..da90658aa --- /dev/null +++ b/assets/js/forms/KimaiDateNowForm.js @@ -0,0 +1,70 @@ +/* + * This file is part of the Kimai time-tracking app. + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +/*! + * [KIMAI] KimaiEditTimesheetForm: responsible for the most important form in the application + */ + +import KimaiFormPlugin from "./KimaiFormPlugin"; + +/** + */ +export default class KimaiDateNowForm extends KimaiFormPlugin { + + init() + { + this.selector = 'a[data-form-widget="date-now"]'; + } + + /** + * @param {HTMLFormElement} form + * @return boolean + */ + supportsForm(form) // eslint-disable-line no-unused-vars + { + return true; + } + + /** + * @param {HTMLFormElement} form + */ + activateForm(form) + { + [].slice.call(form.querySelectorAll(this.selector)).map((element) => { + if (element.dataset.format !== undefined && element.dataset.target !== undefined) { + if (this._eventHandler === undefined) { + this._eventHandler = (event) => { + const linkTarget = event.currentTarget; + + const formElement = document.getElementById(linkTarget.dataset.target); + if (!formElement.disabled) { + formElement.value = this.getDateUtils().format(linkTarget.dataset.format, null); + formElement.dispatchEvent(new Event('change', {bubbles: true})); + } + + event.preventDefault(); + }; + } + element.addEventListener('click', this._eventHandler); + } + }); + + } + + /** + * @param {HTMLFormElement} form + */ + destroyForm(form) + { + [].slice.call(form.querySelectorAll(this.selector)).map((element) => { + if (element.dataset.format !== undefined && element.dataset.target !== undefined) { + element.removeEventListener('click', this._eventHandler); + } + }); + } + +} diff --git a/assets/js/forms/KimaiDatePicker.js b/assets/js/forms/KimaiDatePicker.js new file mode 100644 index 000000000..a0e308c34 --- /dev/null +++ b/assets/js/forms/KimaiDatePicker.js @@ -0,0 +1,113 @@ +/* + * This file is part of the Kimai time-tracking app. + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +/*! + * [KIMAI] KimaiDatePicker: single date selects (currently unused) + */ + +import { Litepicker } from 'litepicker'; +import 'litepicker/dist/plugins/mobilefriendly'; +import KimaiFormPlugin from "./KimaiFormPlugin"; + +export default class KimaiDatePicker extends KimaiFormPlugin { + + constructor(selector) + { + super(); + this._selector = selector; + } + + init() + { + window.disableLitepickerStyles = true; + this._pickers = []; + } + + /** + * @param {HTMLFormElement} form + * @return boolean + */ + supportsForm(form) // eslint-disable-line no-unused-vars + { + return true; + } + + /** + * @param {HTMLFormElement} form + */ + activateForm(form) + { + const FIRST_DOW = this.getConfigurations().getFirstDayOfWeek(false); + const LANGUAGE = this.getConfigurations().getLanguage(); + + let options = { + buttonText: { + previousMonth: ``, + nextMonth: ``, + apply: this.translate('confirm'), + cancel: this.translate('cancel'), + }, + }; + + const newPickers = [].slice.call(form.querySelectorAll(this._selector)).map((element) => { + if (element.dataset.format === undefined) { + console.log('Trying to bind litepicker to an element without data-format attribute'); + } + options = {...options, ...{ + format: element.dataset.format, + showTooltip: false, + element: element, + lang: LANGUAGE, + autoRefresh: true, + firstDay: FIRST_DOW, // Litepicker: 0 = Sunday, 1 = Monday + setup: (picker) => { + // nasty hack, because litepicker does not trigger change event on the input and the available + // event "selected" is triggered why to often, even when moving the cursor inside the input + // element (not even typing is necessary) and so we have to make sure that the manual "click" event + // (works for touch as well) happened before we actually dispatch the change event manually ... + // what? report forms would be submitted upon cursor move without the "preselect” check + picker.on('preselect', (date1, date2) => { // eslint-disable-line no-unused-vars + picker._wasPreselected = true; + }); + picker.on('selected', (date1, date2) => { // eslint-disable-line no-unused-vars + if (picker._wasPreselected !== undefined) { + element.dispatchEvent(new Event('change', {bubbles: true})); + delete picker._wasPreselected; + } + }); + }, + }}; + + return [element, new Litepicker(this.prepareOptions(options))]; + }); + + this._pickers = this._pickers.concat(newPickers); + } + + prepareOptions(options) + { + return {...options, ...{ + plugins: ['mobilefriendly'], + }}; + } + + /** + * @param {HTMLFormElement} form + */ + destroyForm(form) + { + [].slice.call(form.querySelectorAll(this._selector)).map((element) => { + for (let i = 0; i < this._pickers.length; i++) { + if (this._pickers[i][0] === element) { + this._pickers[i][1].destroy(); + this._pickers.splice(i, 1); + } + } + }); + } + +} diff --git a/assets/js/forms/KimaiDateRangePicker.js b/assets/js/forms/KimaiDateRangePicker.js new file mode 100644 index 000000000..24aa2f972 --- /dev/null +++ b/assets/js/forms/KimaiDateRangePicker.js @@ -0,0 +1,25 @@ +/* + * This file is part of the Kimai time-tracking app. + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +/*! + * [KIMAI] KimaiDateRangePicker: activate the (daterange picker) compound field in toolbar + */ + +import KimaiDatePicker from "./KimaiDatePicker"; + +export default class KimaiDateRangePicker extends KimaiDatePicker { + + prepareOptions(options) + { + return {...options, ...{ + plugins: ['mobilefriendly'], + singleMode: false, + autoRefresh: true, + }}; + } + +} diff --git a/assets/js/forms/KimaiFormPlugin.js b/assets/js/forms/KimaiFormPlugin.js new file mode 100644 index 000000000..37b6e706d --- /dev/null +++ b/assets/js/forms/KimaiFormPlugin.js @@ -0,0 +1,39 @@ +/* + * This file is part of the Kimai time-tracking app. + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +/*! + * [KIMAI] KimaiFormPlugin: base class for all none ID plugin that handle forms + */ + +import KimaiPlugin from '../KimaiPlugin'; + +export default class KimaiFormPlugin extends KimaiPlugin { + + /** + * @param {HTMLFormElement} form + * @return boolean + */ + supportsForm(form) // eslint-disable-line no-unused-vars + { + return false; + } + + /** + * @param {HTMLFormElement} form + */ + activateForm(form) // eslint-disable-line no-unused-vars + { + } + + /** + * @param {HTMLFormElement} form + */ + destroyForm(form) // eslint-disable-line no-unused-vars + { + } + +} diff --git a/assets/js/forms/KimaiFormSelect.js b/assets/js/forms/KimaiFormSelect.js new file mode 100644 index 000000000..2f2e15c21 --- /dev/null +++ b/assets/js/forms/KimaiFormSelect.js @@ -0,0 +1,574 @@ +/* + * This file is part of the Kimai time-tracking app. + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +/*! + * [KIMAI] KimaiFormSelect: enhanced functionality for HTMLSelectElement + */ + +import TomSelect from 'tom-select'; +import KimaiFormPlugin from "./KimaiFormPlugin"; + +export default class KimaiFormSelect extends KimaiFormPlugin { + + constructor(selector, apiSelects) + { + super(); + this._selector = selector; + this._apiSelects = apiSelects; + } + + getId() + { + return 'form-select'; + } + + init() + { + // selects the original value inside dropdowns, as the "reset" event (the updated option) + // is not automatically propagated to the JS element + document.addEventListener('reset', (event) => { + if (event.target.tagName.toUpperCase() === 'FORM') { + setTimeout(() => { + const fields = event.target.querySelectorAll(this._selector); + for (let field of fields) { + if (field.tagName.toUpperCase() === 'SELECT') { + field.dispatchEvent(new Event('data-reloaded')); + } + } + }, 10); + } + }); + } + + /** + * @param {HTMLFormElement} node + */ + activateSelectPickerByElement(node) + { + let plugins = ['change_listener']; + + const isMultiple = node.multiple !== undefined && node.multiple === true; + + /* + const isOrdering = false; + if (isOrdering) { + plugins.push('caret_position'); + plugins.push('drag_drop'); + } + */ + + if (isMultiple) { + plugins.push('remove_button'); + } + + let options = { + lockOptgroupOrder: true, + allowEmptyOption: true, + plugins: plugins, + // if there are more than X entries, the other ones are hidden and can only be found + // by typing some characters to trigger the internal option search + maxOptions: 500, + }; + + let render = { + option_create: (data, escape) => { + const name = escape(data.input); + if (name.length < 3) { + return null; + } + const tpl = this.translate('select.search.create'); + const tplReplaced = tpl.replace('%input%', '' + name + ''); + return '
' + tplReplaced + '
'; + }, + no_results: (data, escape) => { + const tpl = this.translate('select.search.notfound'); + const tplReplaced = tpl.replace('%input%', '' + escape(data.input) + ''); + return '
' + tplReplaced + '
'; + }, + onOptionAdd: (value) => { + node.dispatchEvent(new CustomEvent('create', {detail: {'value': value}})); + }, + }; + + if (node.dataset['create'] !== undefined) { + options = {...options, ...{ + persist: true, + create: true, + }}; + } else { + options = {...options, ...{ + persist: false, + create: false, + }}; + } + + if (node.dataset.disableSearch !== undefined) { + options = {...options, ...{ + controlInput: null, + }}; + } + + if (node.dataset['renderer'] !== undefined && node.dataset['renderer'] === 'color') { + options.render = {...render, ...{ + option: function(data, escape) { + let color = data.value; + if (data.color !== undefined) { + color = data.color; + } + return '
 ' + escape(data.text) + '
'; + }, + item: function(data, escape) { + let color = data.value; + if (data.color !== undefined) { + color = data.color; + } + return '
 ' + escape(data.text) + '
'; + } + }}; + } else { + options.render = {...render, ...{ + // the empty entry would collapse and only show as a tiny 5px line if there is no content inside + option: function(data, escape) { + let text = data.text; + if (text === null || text.trim() === '') { + text = ' '; + } else { + text = escape(text); + } + return '
' + text + '
'; + } + }}; + } + + const select = new TomSelect(node, options); + node.addEventListener('data-reloaded', (event) => { + select.clear(true); + select.clearOptionGroups(); + select.clearOptions(); + select.sync(); + select.setValue(event.detail); + select.refreshItems(); + select.refreshOptions(false); + }); + + // support reloading the list upon external event + if (node.dataset['reload'] !== undefined) { + node.addEventListener('reload', () => { + select.disable(); + node.disabled = true; + + /** @type {KimaiAPI} API */ + const API = this.getContainer().getPlugin('api'); + + API.get(node.dataset['reload'], {}, (data) => { + this._updateSelect(node, data); + select.enable(); + node.disabled = false; + }); + + node.dispatchEvent(new Event('change')); + }); + } + } + + /** + * @param {HTMLFormElement} form + * @return boolean + */ + supportsForm(form) // eslint-disable-line no-unused-vars + { + return true; + } + + /** + * @param {HTMLFormElement} form + */ + activateForm(form) + { + [].slice.call(form.querySelectorAll(this._selector)).map((node) => { + this.activateSelectPickerByElement(node); + }); + + this._activateApiSelects(this._apiSelects); + } + + /** + * @param {HTMLFormElement} form + */ + destroyForm(form) + { + [].slice.call(form.querySelectorAll(this._selector)).map((node) => { + if (node.tomselect) { + node.tomselect.destroy(); + } + }); + } + + /** + * @param {string|Element} selectIdentifier + * @param {object} data + * @private + */ + _updateOptions(selectIdentifier, data) + { + let emptyOption = null; + let node = null; + if (selectIdentifier instanceof Element) { + node = selectIdentifier; + } else { + node = document.querySelector(selectIdentifier); + } + if (node === null) { + console.log('Missing select: ' + selectIdentifier); + return; + } + const selectedValue = node.value; + + for (let i = 0; i < node.options.length; i++) { + if (node.options[i].value === '') { + emptyOption = node.options[i]; + } + } + + node.options.length = 0; + + if (emptyOption !== null) { + node.appendChild(this._createOption(emptyOption.text, '')); + } + + let emptyOpts = []; + let options = []; + /** @type {string|null} titlePattern */ + let titlePattern = null; + if (node.dataset !== undefined && node.dataset['optionPattern'] !== undefined) { + titlePattern = node.dataset['optionPattern']; + } + if (titlePattern === null || titlePattern === '') { + titlePattern = '{name}'; + } + + for (const [key, value] of Object.entries(data)) { + if (key === '__empty__') { + for (const entity of value) { + emptyOpts.push(this._createOption(this._getTitleFromPattern(titlePattern, entity), entity.id)); + } + continue; + } + + let optGroup = this._createOptgroup(key); + for (const entity of value) { + optGroup.appendChild(this._createOption(this._getTitleFromPattern(titlePattern, entity), entity.id)); + } + options.push(optGroup); + } + + options.forEach(child => node.appendChild(child)); + emptyOpts.forEach(child => node.appendChild(child)); + + // if available, re-select the previous selected option (mostly usable for global activities) + node.value = selectedValue; + + // pre-select an option if it is the only available one + if (node.value === '' || node.value === null) { + const allOptions = node.options; + const optionLength = allOptions.length; + let selectOption = ''; + + if (optionLength === 1) { + selectOption = allOptions[0].value; + } else if (optionLength === 2 && emptyOption !== null) { + selectOption = allOptions[1].value; + } + + if (selectOption !== '') { + node.value = selectOption; + } + } + + // this will update the attached javascript component + node.dispatchEvent(new CustomEvent('data-reloaded', {detail: node.value})); + // if we don't trigger the change, the other selects won't reset + node.dispatchEvent(new Event('change')); + } + + /** + * @param {string} pattern + * @param {array} entity + * @private + */ + _getTitleFromPattern(pattern, entity) + { + const DATE_UTILS = this.getDateUtils(); + const regexp = new RegExp('{[^}]*?}','g'); + let title = pattern; + let match = null; + + while ((match = regexp.exec(pattern)) !== null) { + // cutting a string like "{name}" into "name" + const field = match[0].slice(1, -1); + let value = entity[field] === undefined ? null : entity[field]; + if ((field === 'start' || field === 'end')) { + if (value === null) { + value = '?'; + } else { + value = DATE_UTILS.getFormattedDate(value); + } + } + + title = title.replace(new RegExp('{' + field + '}', 'g'), value ?? ''); + } + title = title.replace(/- \?-\?/, ''); + title = title.replace(/\r\n|\r|\n/g, ' '); + title = title.substring(0, 110); + + const chars = '- '; + let start = 0, end = title.length; + + while (start < end && chars.indexOf(title[start]) >= 0) { + ++start; + } + + while (end > start && chars.indexOf(title[end - 1]) >= 0) { + --end; + } + + return (start > 0 || end < title.length) ? title.substring(start, end) : title; + } + + /** + * @param {HTMLSelectElement} select + * @param {string} label + * @param {string} value + * @param {object} dataset + */ + addOption(select, label, value, dataset) + { + const option = this._createOption(label, value); + for (const key in dataset) { + option.dataset[key] = dataset[key]; + } + + select.options.add(option); + if (select.tomselect !== undefined) { + select.tomselect.sync(); + } + } + + /** + * + * @param {HTMLSelectElement} select + * @param {HTMLOptionElement} option + */ + removeOption(select, option) + { + option.remove(); + if (select.tomselect !== undefined) { + select.tomselect.removeOption(option.value, true); + select.tomselect.clear(true); + } + } + + /** + * @param {string} label + * @param {string} value + * @returns {HTMLElement} + * @private + */ + _createOption(label, value) + { + let option = document.createElement('option'); + option.innerText = label; + option.value = value; + return option; + } + + /** + * @param {string} label + * @returns {HTMLElement} + * @private + */ + _createOptgroup(label) + { + let optGroup = document.createElement('optgroup'); + optGroup.label = label; + return optGroup; + } + + /** + * @param {string} selector + * @private + */ + _activateApiSelects(selector) + { + if (this._eventHandlerApiSelects === undefined) { + this._eventHandlerApiSelects = (event) => { + if (event.target === null || !event.target.matches(selector)) { + return; + } + + const apiSelect = event.target; + const targetSelectId = '#' + apiSelect.dataset['relatedSelect']; + /** @type {HTMLSelectElement} targetSelect */ + const targetSelect = document.getElementById(apiSelect.dataset['relatedSelect']); + + // if the related target select does not exist, we do not need to load the related data + if (targetSelect === null) { + return; + } + + if (targetSelect.tomselect !== undefined) { + targetSelect.tomselect.disable(); + } + targetSelect.disabled = true; + + let formPrefix = apiSelect.dataset['formPrefix']; + if (formPrefix === undefined || formPrefix === null) { + formPrefix = ''; + } else if (formPrefix.length > 0) { + formPrefix += '_'; + } + + let newApiUrl = this._buildUrlWithFormFields(apiSelect.dataset['apiUrl'], formPrefix); + + const selectValue = apiSelect.value; + + // Problem: select a project with activities and then select a customer that has no project + // results in a wrong URL, it triggers "activities?project=" instead of using the "emptyUrl" + if (selectValue === undefined || selectValue === null || selectValue === '' || (Array.isArray(selectValue) && selectValue.length === 0)) { + if (apiSelect.dataset['emptyUrl'] === undefined) { + this._updateSelect(targetSelectId, {}); + return; + } + newApiUrl = this._buildUrlWithFormFields(apiSelect.dataset['emptyUrl'], formPrefix); + } + + /** @type {KimaiAPI} API */ + const API = this.getContainer().getPlugin('api'); + + API.get(newApiUrl, {}, (data) => { + this._updateSelect(targetSelectId, data); + if (targetSelect.tomselect !== undefined) { + targetSelect.tomselect.enable(); + } + targetSelect.disabled = false; + }); + } + + document.addEventListener('change', this._eventHandlerApiSelects); + } + } + + /** + * @param {string} apiUrl + * @param {string} formPrefix + * @return {string} + * @private + */ + _buildUrlWithFormFields(apiUrl, formPrefix) + { + let newApiUrl = apiUrl; + + apiUrl.split('?')[1].split('&').forEach(item => { + const [key, value] = item.split('='); // eslint-disable-line no-unused-vars + const decoded = decodeURIComponent(value); + const test = decoded.match(/%(.*)%/); + if (test !== null) { + const originalFieldName = test[1]; + const targetFieldName = (formPrefix + originalFieldName).replace(/\[/, '').replace(/]/, ''); + const targetField = document.getElementById(targetFieldName); + let newValue = ''; + if (targetField === null) { + // happens for example: + // - in duration only mode, when the end field is not found + // console.log('ERROR: Cannot find field with name "' + test[1] + '" by selector: #' + formPrefix + test[1]); + } else { + if (targetField.value !== null) { + newValue = targetField.value; + if (targetField.tagName === 'SELECT' && targetField.multiple) { + newValue = [...targetField.selectedOptions].map(o => o.value); + } else if (newValue !== '') { + if (targetField.type === 'date') { + const timeId = targetField.id.replace('_date', '_time') + const timeElement = document.getElementById(timeId); + const time = timeElement === null ? '12:00:00' : timeElement.value; + // using 12:00 as fallback, because timezone handling might change the date if we use 00:00 + const newDate = this.getDateUtils().fromHtml5Input(newValue, time); + newValue = this.getDateUtils().formatForAPI(newDate, false); + } else if (targetField.type === 'text' && targetField.name.includes('date')) { + const timeId = targetField.id.replace('_date', '_time') + const timeElement = document.getElementById(timeId); + // using 12:00 as fallback, because timezone handling might change the date if we use 00:00 + let time = '12:00:00'; + let timeFormat = 'HH:mm'; + if (timeElement !== null) { + time = timeElement.value; + timeFormat = timeElement.dataset['format']; + } + const newDate = this.getDateUtils().fromFormat(newValue.trim() + ' ' + time.trim(), targetField.dataset['format'] + ' ' + timeFormat); + newValue = this.getDateUtils().formatForAPI(newDate, false); + } else if (targetField.dataset['format'] !== undefined) { + // find out when this else branch is triggered and document! + + if (this.getDateUtils().isValidDateTime(newValue, targetField.dataset['format'])) { + newValue = this.getDateUtils().format(targetField.dataset['format'], newValue); + } + } + } else { + // happens for example: + // - when the end date is not set on a timesheet record and the project list is loaded (as the URL contains the %end% replacer) + // console.log('Empty value found for field with name "' + test[1] + '" by selector: #' + formPrefix + test[1]); + } + } else { + // happens for example: + // - when a customer without projects is selected + // console.log('ERROR: Empty field with name "' + test[1] + '" by selector: #' + formPrefix + test[1]); + } + } + + + if (Array.isArray(newValue)) { + let urlParams = []; + for (let tmpValue of newValue) { + urlParams.push(originalFieldName + '=' + tmpValue); + } + newApiUrl = newApiUrl.replace(item, urlParams.join('&')); + } else { + newApiUrl = newApiUrl.replace(value, newValue); + } + } + }); + + return newApiUrl; + } + + /** + * @param {string|Element} select + * @param {object} data + * @private + */ + _updateSelect(select, data) + { + const options = {}; + for (const apiData of data) { + let title = '__empty__'; + if (apiData['parentTitle'] !== undefined && apiData['parentTitle'] !== null) { + title = apiData['parentTitle']; + } + if (options[title] === undefined) { + options[title] = []; + } + options[title].push(apiData); + } + + const ordered = {}; + Object.keys(options).sort().forEach(function(key) { + ordered[key] = options[key]; + }); + + this._updateOptions(select, ordered); + } +} diff --git a/assets/js/forms/KimaiTeamForm.js b/assets/js/forms/KimaiTeamForm.js new file mode 100644 index 000000000..e0f09f14a --- /dev/null +++ b/assets/js/forms/KimaiTeamForm.js @@ -0,0 +1,145 @@ +/* + * This file is part of the Kimai time-tracking app. + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +/*! + * [KIMAI] KimaiEditTimesheetForm: responsible for the most important form in the application + */ + +import KimaiFormPlugin from "./KimaiFormPlugin"; +import KimaiColor from "../widgets/KimaiColor"; + +export default class KimaiTeamForm extends KimaiFormPlugin { + + init() + { + this.usersId = 'team_edit_form_users'; + } + + /** + * @param {HTMLFormElement} form + * @return boolean + */ + supportsForm(form) + { + return form.name === 'team_edit_form'; + } + + /** + * @return {HTMLElement} + * @private + */ + _getPrototype() + { + return document.getElementById('team_edit_form_members'); + } + + /** + * @param {HTMLFormElement} form + */ + activateForm(form) + { + if (!this.supportsForm(form)) { + return; + } + + // must be attached to the form, because the button is added dynamically + form.addEventListener('click', event => this._removeMember(event)); + + document.getElementById(this.usersId).addEventListener('change', event => { + const select = event.target; + const option = select.options[select.selectedIndex]; + const member = this._createMember(option); + this._getPrototype().append(member); + this.getPlugin('form-select').removeOption(select, option); + }); + } + + /** + * @param {HTMLOptionElement} option + * @returns {Element} + * @private + */ + _createMember(option) + { + const prototype = this._getPrototype(); + let counter = prototype.dataset['widgetCounter'] || prototype.childNodes.length; + let newWidget = prototype.dataset['prototype']; + + newWidget = newWidget.replace(/__name__/g, counter); + + newWidget = newWidget.replace(/#000000/g, KimaiColor.calculateContrastColor(option.dataset.color)); + newWidget = newWidget.replace(/__DISPLAY__/g, option.dataset.display); + newWidget = newWidget.replace(/__COLOR__/g, option.dataset.color); + newWidget = newWidget.replace(/__INITIALS__/g, option.dataset.initials); + newWidget = newWidget.replace(/__TITLE__/g, option.dataset.title); + newWidget = newWidget.replace(/__USERNAME__/g, option.text); + + prototype.dataset['widgetCounter'] = (++counter).toString(); + + const temp = document.createElement('div'); + temp.innerHTML = newWidget; + temp.querySelector('input[type=hidden]').value = option.value; + + const newNode = temp.firstElementChild; + + // copy over all initial settings, so we are able to rebuild the original option if the + // member is removed from the list later on + for (const key in option.dataset) { + newNode.dataset[key] = option.dataset[key]; + } + + return newNode; + } + + /** + * @param {Event} event + * @private + */ + _removeMember(event) + { + let button = event.target; + + if (button.parentNode.matches('.remove-member')) { + button = button.parentNode; + } + + if (button.matches('.remove-member')) { + // see blocks.html.twig => block team_member_widget + const element = button.parentNode.parentNode.parentNode.parentNode.parentNode; + + // re-adding the option to the select makes up for form validation errors + // because the list would have to be re-ordered and indices need to be changed ... + /* + this.getPlugin('form-select').addOption( + document.getElementById(this.usersId), + element.dataset['display'], + element.dataset['id'], + element.dataset + ); + const prototype = this._getPrototype(); + prototype.dataset['widgetCounter'] = (prototype.dataset['widgetCounter'] - 1).toString(); + */ + + element.remove(); + event.stopPropagation(); + event.preventDefault(); + } + } + + /** + * @param {HTMLFormElement} form + */ + destroyForm(form) + { + if (!this.supportsForm(form)) { + return; + } + + form.removeEventListener('click', this._removeMember); + } + +} diff --git a/assets/js/forms/KimaiTimesheetForm.js b/assets/js/forms/KimaiTimesheetForm.js new file mode 100644 index 000000000..8ea6676ec --- /dev/null +++ b/assets/js/forms/KimaiTimesheetForm.js @@ -0,0 +1,368 @@ +/* + * This file is part of the Kimai time-tracking app. + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +/*! + * [KIMAI] KimaiEditTimesheetForm: responsible for the most important form in the application + */ + +import { DateTime } from 'luxon'; +import KimaiFormPlugin from "./KimaiFormPlugin"; + +export default class KimaiTimesheetForm extends KimaiFormPlugin { + + /** + * @param {HTMLFormElement} form + * @return boolean + */ + supportsForm(form) + { + return (form.name === 'timesheet_edit_form' || form.name ==='timesheet_admin_edit_form' || form.name ==='timesheet_multi_user_edit_form'); + } + + /** + * @param {HTMLFormElement} form + */ + destroyForm(form) + { + if (!this.supportsForm(form)) { + return; + } + + if (this._beginDate !== undefined) { + this._beginDate.removeEventListener('change', this._beginListener); + delete this._beginListener; + delete this._beginDate; + } + + if (this._beginTime !== undefined) { + this._beginTime.removeEventListener('change', this._beginListener); + delete this._beginTime; + } + + if (this._endTime !== undefined) { + this._endTime.removeEventListener('change', this._endListener); + delete this._endTime; + } + + if (this._duration !== undefined) { + this._duration.removeEventListener('change', this._durationListener); + delete this._durationListener; + delete this._duration; + } + + if (this._durationToggle !== undefined && this._durationToggle !== null) { + this._durationToggle.removeEventListener('change', this._durationToggleListener); + delete this._durationToggleListener; + delete this._durationToggle; + } + + if (this._activity !== undefined) { + this._activity.removeEventListener('create', this._activityListener); + delete this._activityListener; + delete this._activity; + } + + if (this._project !== undefined) { + delete this._project; + } + } + + activateForm(form) + { + if (!this.supportsForm(form)) { + return; + } + + const formPrefix = form.name; + + this._activity = document.getElementById(formPrefix + '_activity'); + this._project = document.getElementById(formPrefix + '_project'); + + /** @param {CustomEvent} event */ + this._activityListener = (event) => { + const project = this._project.value; + /** @type {KimaiAPI} API */ + const API = this.getContainer().getPlugin('api'); + API.post(this._activity.dataset['create'], { + name: event.detail.value, + project: (project === '' ? null : project), + visible: true, + }, () => { + this._project.dispatchEvent(new Event('change')); + }); + }; + this._activity.addEventListener('create', this._activityListener); + + this._beginDate = document.getElementById(formPrefix + '_begin_date'); + this._beginTime = document.getElementById(formPrefix + '_begin_time'); + this._endTime = document.getElementById(formPrefix + '_end_time'); + this._duration = document.getElementById(formPrefix + '_duration'); + this._durationToggle = document.getElementById(formPrefix + '_duration_toggle'); + + if (this._beginDate === null || this._beginTime === null || this._endTime === null || this._duration === null) { + return; + } + + this._beginListener = () => this._changedBegin(); + this._endListener = () => this._changedEnd(); + this._durationListener = () => this._changedDuration(); + + this._beginDate.addEventListener('change', this._beginListener); + this._beginTime.addEventListener('change', this._beginListener); + this._endTime.addEventListener('change', this._endListener); + this._duration.addEventListener('change', this._durationListener); + + if (this._duration !== null && this._durationToggle !== null) { + this._durationToggleListener = () => { + this._durationToggle.classList.toggle('text-success'); + }; + this._durationToggle.addEventListener('click', this._durationToggleListener); + } + } + + _isDurationConnected() + { + if (this._duration === null && this._durationToggle === null) { + return false; + } + + if (this._durationToggle === null) { + return true; + } + + return this._durationToggle.classList.contains('text-success'); + } + + /** + * @returns {DateTime|null} + * @private + */ + _getBegin() + { + if (this._beginDate.value === '' || this._beginTime.value === '') { + return null; + } + + const date = this.getDateUtils().fromFormat( + this._beginDate.value + ' ' + this._beginTime.value, + this._beginDate.dataset['format'] + ' ' + this._beginTime.dataset['format'], + ); + + if (date.invalid) { + return null; + } + + return date; + } + + /** + * @returns {DateTime|null} + * @private + */ + _getEnd() + { + if (this._endTime.value === '') { + return null; + } + + let date = this.getDateUtils().fromFormat( + DateTime.now().toFormat('yyyy-LL-dd') + ' ' + this._endTime.value, + 'yyyy-LL-dd ' + this._endTime.dataset['format'], + ); + + const begin = this._getBegin(); + if (begin !== null) { + date = this.getDateUtils().fromFormat( + begin.toFormat('yyyy-LL-dd') + ' ' + this._endTime.value, + 'yyyy-LL-dd ' + this._endTime.dataset['format'], + ); + + if (date < begin) { + date = date.plus({days: 1}); + } + } + + if (date.invalid) { + return null; + } + + return date; + } + + /** + * Ruleset: + * - invalid begin => skip + * - empty end => set end to begin (only if duration > 0 = running record) + * - invalid end => skip + * - calculate duration + */ + _changedBegin() + { + const begin = this._getBegin(); + if (begin === null) { + return; + } + + const duration = this._getParsedDuration(); + const hasDuration = duration.as('seconds') > 0; + const end = this._getEnd(); + + if (end === null && hasDuration) { + this._applyDateToField(begin.plus(duration), null, this._endTime); + } else { + this._updateDuration(); + } + } + + /** + * Ruleset: + * - invalid end => skip + * - empty begin => set begin to end + * - invalid begin => skip + * - calculate duration + */ + _changedEnd() + { + const end = this._getEnd(); + // empty or invalid date => reset duration and stop progress + if (end === null) { + return; + } + + const duration = this._getParsedDuration(); + const hasDuration = duration.as('seconds') > 0; + const begin = this._getBegin(); + + if (begin === null && hasDuration) { + this._applyDateToField(end.minus(duration), this._beginDate, this._beginTime); + } else { + this._updateDuration(); + } + } + + /** + * @private + */ + _updateDuration() + { + const begin = this._getBegin(); + const end = this._getEnd(); + let newDuration = null; + + if (begin !== null && end !== null) { + newDuration = end.diff(begin); + } + + this._setDurationAsString(newDuration); + } + + /** + * Ruleset: + * - invalid duration => skip + * - if begin and end are empty: set begin to now and end to duration + * - if begin is empty and end is not empty: set begin to end minus duration + * - if begin is not empty and end is empty and duration is > 0 (running records = 0): set end to begin plus duration + */ + _changedDuration() + { + if (!this._isDurationConnected()) { + return; + } + + const duration = this._getParsedDuration(); + if (!duration.isValid) { + this._setDurationAsString(null); + return; + } + + const begin = this._getBegin(); + let end = this._getEnd(); + const seconds = duration.as('seconds'); + + if (seconds < 0) { + end = null; + } + + if (begin === null && end === null) { + const newBegin = DateTime.now(); + this._applyDateToField(newBegin, this._beginDate, this._beginTime); + this._applyDateToField(newBegin.plus({seconds: seconds}), null, this._endTime); + } else if (begin === null && end !== null) { + this._applyDateToField(end.minus({seconds: seconds}), this._beginDate, this._beginTime); + } else if (begin !== null && seconds > 0) { + this._applyDateToField(begin.plus({seconds: seconds}), null, this._endTime); + } + } + + /** + * Writes the value of a duration object as human-readable string into the duration field + * + * @param {Duration|null} duration + */ + _setDurationAsString(duration) + { + if (!this._isDurationConnected()) { + return; + } + + if (duration === null) { + this._duration.value = ''; + return; + } + + if (!duration.isValid) { + return; + } + + const seconds = duration.as('seconds'); + if (seconds < 0) { + this._duration.value = ''; + return; + } + + const hours = Math.floor(seconds / 3600); + let minutes = Math.floor((seconds - (hours * 3600)) / 60); + + if (minutes < 10) { + minutes = '0' + minutes; + } + + this._duration.value = hours + ':' + minutes; + } + + /** + * Returns a duration object from the duration input field. + * + * @private + * @return {Duration} + */ + _getParsedDuration() + { + return this.getDateUtils().parseDuration(this._duration.value.toUpperCase()); + } + + /** + * @param {DateTime|null} dateTime + * @param {HTMLElement|null} dateField + * @param {HTMLElement} timeField + * @private + */ + _applyDateToField(dateTime, dateField, timeField) + { + if (dateTime === null || dateTime.invalid) { + dateField.value = ''; + timeField.value = ''; + return; + } + + if (dateField !== null) { + dateField.value = this.getDateUtils().format(dateField.dataset['format'], dateTime); + } + timeField.value = this.getDateUtils().format(timeField.dataset['format'], dateTime); + } + +} diff --git a/assets/js/plugins/KimaiAPI.js b/assets/js/plugins/KimaiAPI.js index 2b72b4667..08de49aa1 100644 --- a/assets/js/plugins/KimaiAPI.js +++ b/assets/js/plugins/KimaiAPI.js @@ -9,7 +9,6 @@ * [KIMAI] KimaiAPI: easy access to API methods */ -import jQuery from 'jquery'; import KimaiPlugin from "../KimaiPlugin"; export default class KimaiAPI extends KimaiPlugin { @@ -18,135 +17,162 @@ export default class KimaiAPI extends KimaiPlugin { return 'api'; } + _headers() { + const headers = new Headers(); + headers.append('X-AUTH-SESSION', '1'); + headers.append('Content-Type', 'application/json'); + + return headers; + } + get(url, data, callbackSuccess, callbackError) { - jQuery.ajax({ - url: url, - headers: { - 'X-AUTH-SESSION': true, - 'Content-Type':'application/json' - }, + if (data !== undefined) { + const params = (new URLSearchParams(data)).toString(); + if (params !== '') { + url = url + (url.includes('?') ? '&' : '?') + params; + } + } + + if (callbackError === undefined) { + callbackError = (error) => { + this.handleError('An error occurred', error); + }; + } + + this.fetch(url, { method: 'GET', - data: data, - dataType: 'json', - success: callbackSuccess, - error: callbackError + headers: this._headers() + }).then((response) => { + response.json().then((json) => { + callbackSuccess(json); + }); + }).catch((error) => { + callbackError(error); }); } post(url, data, callbackSuccess, callbackError) { - if (callbackError === null || callbackError === undefined) { - callbackError = this.getPostErrorHandler(); + if (callbackError === undefined) { + callbackError = (error) => { + this.handleError('action.update.error', error); + }; } - jQuery.ajax({ - url: url, - headers: { - 'X-AUTH-SESSION': true, - 'Content-Type':'application/json' - }, + this.fetch(url, { method: 'POST', - data: data, - dataType: 'json', - success: callbackSuccess, - error: callbackError + body: this._parseData(data), + headers: this._headers() + }).then((response) => { + response.json().then((json) => { + callbackSuccess(json); + }); + }).catch((error) => { + callbackError(error); }); } patch(url, data, callbackSuccess, callbackError) { - if (callbackError === null || callbackError === undefined) { - callbackError = this.getPatchErrorHandler(); + if (callbackError === undefined) { + callbackError = (error) => { + this.handleError('action.update.error', error); + }; } - jQuery.ajax({ - url: url, - headers: { - 'X-AUTH-SESSION': true, - 'Content-Type':'application/json' - }, + this.fetch(url, { method: 'PATCH', - data: data, - dataType: 'json', - success: callbackSuccess, - error: callbackError + body: this._parseData(data), + headers: this._headers() + }).then((response) => { + if (response.statusCode === 204) { + callbackSuccess(); + } else { + response.json().then((json) => { + callbackSuccess(json); + }); + } + }).catch((error) => { + callbackError(error); }); } delete(url, callbackSuccess, callbackError) { - if (callbackError === null || callbackError === undefined) { - callbackError = this.getDeleteErrorHandler(); + if (callbackError === undefined) { + callbackError = (error) => { + this.handleError('action.delete.error', error); + }; } - jQuery.ajax({ - url: url, - headers: { - 'X-AUTH-SESSION': true, - 'Content-Type':'application/json' - }, + this.fetch(url, { method: 'DELETE', - dataType: 'json', - success: callbackSuccess, - error: callbackError + headers: this._headers() + }).then(() => { + callbackSuccess(); + }).catch((error) => { + callbackError(error); }); } - getDeleteErrorHandler() { - const self = this; - return function(xhr, err) { - self.handleError('action.delete.error', xhr, err); - }; - } + /** + * @param {string|object} data + * @returns {string} + * @private + */ + _parseData(data) { + if (typeof data === 'object') { + return JSON.stringify(data); + } - getPatchErrorHandler() { - const self = this; - return function(xhr, err) { - self.handleError('action.update.error', xhr, err); - }; - } - - getPostErrorHandler() { - const self = this; - return function(xhr, err) { - self.handleError('action.update.error', xhr, err); - }; + return data; } /** * @param {string} message - * @param {jqXHR} xhr - * @param {string} err + * @param {Response} response */ - handleError(message, xhr, err) { - let resultError = err; - if (xhr.responseJSON && xhr.responseJSON.message) { - resultError = xhr.responseJSON.message; - // find validation errors - if (xhr.status === 400 && xhr.responseJSON.errors) { - let collected = ['' + resultError + '']; - // form errors that are not attached to a field (like extra fields) - if (xhr.responseJSON.errors.errors) { - for (let error of xhr.responseJSON.errors.errors) { - collected.push(error); + handleError(message, response) { + if (response.headers === undefined) { + // this can happen if someone clicks to fast and auto running + // requests (e.g. active records) are aborted + return; + } + + const contentType = response.headers.get("content-type"); + if (contentType && contentType.indexOf("application/json") !== -1) { + response.json().then(data => { + let resultError = data.message; + // find validation errors + if (response.status === 400 && data.errors) { + let collected = ['' + resultError + '']; + // form errors that are not attached to a field (like extra fields) + if (data.errors.errors) { + for (let error of data.errors.errors) { + collected.push(error); + } } - } - if (xhr.responseJSON.errors.children) { - for (let field in xhr.responseJSON.errors.children) { - let tmpField = xhr.responseJSON.errors.children[field]; - if (tmpField.hasOwnProperty('errors') && tmpField.errors.length > 0) { - for (let error of tmpField.errors) { - collected.push(error); + if (data.errors.children) { + for (let field in data.errors.children) { + let tmpField = data.errors.children[field]; + if (tmpField.errors !== undefined && tmpField.errors.length > 0) { + for (let error of tmpField.errors) { + collected.push(error); + } } } } + if (collected.length > 0) { + resultError = collected; + } } - if (collected.length > 0) { - resultError = collected; - } - } - } else if (xhr.status && xhr.statusText) { - resultError = '[' + xhr.status + '] ' + xhr.statusText; - } - this.getPlugin('alert').error(message, resultError); + this.getPlugin('alert').error(message, resultError); + + }); + } else { + response.text().then(() => { + const resultError = '[' + response.statusCode + '] ' + response.statusText; + this.getPlugin('alert').error(message, resultError); + }); + } } } diff --git a/assets/js/plugins/KimaiAPILink.js b/assets/js/plugins/KimaiAPILink.js index de33df50d..baaeac05d 100644 --- a/assets/js/plugins/KimaiAPILink.js +++ b/assets/js/plugins/KimaiAPILink.js @@ -22,15 +22,14 @@ export default class KimaiAPILink extends KimaiPlugin { constructor(selector) { super(); - this.selector = selector; + this._selector = selector; } init() { - const self = this; - document.addEventListener('click', function(event) { + document.addEventListener('click', (event) => { let target = event.target; - while (target !== null && !target.matches('body')) { - if (target.classList.contains(self.selector)) { + while (target !== null && typeof target.matches === "function" && !target.matches('body')) { + if (target.classList.contains(this._selector)) { const attributes = target.dataset; let url = attributes['href']; @@ -39,13 +38,13 @@ export default class KimaiAPILink extends KimaiPlugin { } if (attributes.question !== undefined) { - self.getContainer().getPlugin('alert').question(attributes.question, function(value) { + this.getContainer().getPlugin('alert').question(attributes.question, (value) => { if (value) { - self._callApi(url, attributes); + this._callApi(url, attributes); } }); } else { - self._callApi(url, attributes); + this._callApi(url, attributes); } event.preventDefault(); @@ -57,37 +56,45 @@ export default class KimaiAPILink extends KimaiPlugin { }); } + /** + * @param {string} url + * @param {DOMStringMap} attributes + * @private + */ _callApi(url, attributes) { const method = attributes['method']; const eventName = attributes['event']; + /** @type {KimaiAPI} API */ const API = this.getContainer().getPlugin('api'); - const eventing = this.getContainer().getPlugin('event'); - const alert = this.getContainer().getPlugin('alert'); - const successHandle = function(result) { - eventing.trigger(eventName); - if (attributes.msgSuccess) { - alert.success(attributes.msgSuccess); + /** @type {KimaiEvent} EVENTS */ + const EVENTS = this.getContainer().getPlugin('event'); + /** @type {KimaiAlert} ALERT */ + const ALERT = this.getContainer().getPlugin('alert'); + const successHandle = () => { + EVENTS.trigger(eventName); + if (attributes['msgSuccess'] !== undefined) { + ALERT.success(attributes['msgSuccess']); } }; - const errorHandle = function(xhr, err) { + const errorHandle = (error) => { let message = 'action.update.error'; - if (attributes.msgError) { - message = attributes.msgError; + if (attributes['msgError'] !== undefined) { + message = attributes['msgError']; } - API.handleError(message, xhr, err); + API.handleError(message, error); }; if (method === 'PATCH') { let data = {}; - if (attributes.payload) { - data = attributes.payload; + if (attributes['payload'] !== undefined) { + data = attributes['payload']; } API.patch(url, data, successHandle, errorHandle); } else if (method === 'POST') { let data = {}; - if (attributes.payload) { - data = attributes.payload; + if (attributes['payload'] !== undefined) { + data = attributes['payload']; } API.post(url, data, successHandle, errorHandle); } else if (method === 'DELETE') { diff --git a/assets/js/plugins/KimaiActiveRecords.js b/assets/js/plugins/KimaiActiveRecords.js index fd0e5f17d..b5b3b7174 100644 --- a/assets/js/plugins/KimaiActiveRecords.js +++ b/assets/js/plugins/KimaiActiveRecords.js @@ -15,8 +15,8 @@ export default class KimaiActiveRecords extends KimaiPlugin { constructor(selector, selectorEmpty) { super(); - this.selector = selector; - this.selectorEmpty = selectorEmpty; + this._selector = selector; + this._selectorEmpty = selectorEmpty; } getId() { @@ -24,101 +24,146 @@ export default class KimaiActiveRecords extends KimaiPlugin { } init() { - this.menu = document.querySelector(this.selector); + this._menu = document.querySelector(this._selector); // the menu can be hidden if user has no permissions to see it - if (this.menu === null) { + if (this._menu === null) { return; } - this.attributes = this.menu.dataset; + this.attributes = this._menu.dataset; - const self = this; - const handle = function() { self.reloadActiveRecords(); }; + const handleUpdate = () => { + this.reloadActiveRecords(); + }; + document.addEventListener('kimai.timesheetUpdate', handleUpdate); + document.addEventListener('kimai.timesheetDelete', handleUpdate); + document.addEventListener('kimai.activityUpdate', handleUpdate); + document.addEventListener('kimai.activityDelete', handleUpdate); + document.addEventListener('kimai.projectUpdate', handleUpdate); + document.addEventListener('kimai.projectDelete', handleUpdate); + document.addEventListener('kimai.customerUpdate', handleUpdate); + document.addEventListener('kimai.customerDelete', handleUpdate); + + // ----------------------------------------------------------------------- + // handle duration in the visible UI + this._updateBrowserTitle = !!this.getConfiguration('updateBrowserTitle'); + this._updateDuration(); + const handle = () => { + this._updateDuration(); + }; + this._updatesHandler = setInterval(handle, 10000); document.addEventListener('kimai.timesheetUpdate', handle); - document.addEventListener('kimai.timesheetDelete', handle); - document.addEventListener('kimai.activityUpdate', handle); - document.addEventListener('kimai.activityDelete', handle); - document.addEventListener('kimai.projectUpdate', handle); - document.addEventListener('kimai.projectDelete', handle); - document.addEventListener('kimai.customerUpdate', handle); - document.addEventListener('kimai.customerDelete', handle); + document.addEventListener('kimai.reloadedContent', handle); } - _toggleMenu(hasEntries) { - this.menu.style.display = hasEntries ? 'inline-block' : 'none'; + // TODO we could unregister all handler and listener + // _unregisterHandler() { + // clearInterval(this._updatesHandler); + // } + + _updateDuration() { + const activeRecords = this._menu.querySelectorAll('[data-since]:not([data-since=""])'); + + if (activeRecords.length === 0) { + if (this._updateBrowserTitle) { + if (document.body.dataset['title'] === undefined) { + this._updateBrowserTitle = false; + } else { + document.title = document.body.dataset['title']; + } + } + return; + } + + const DATE = this.getDateUtils(); + let durations = []; + + for (const record of activeRecords) { + const duration = DATE.formatDuration(record.dataset['since']); + // only use the ones from the menu for the title + if (record.dataset['replacer'] !== undefined && record.dataset['title'] !== null && duration !== '?') { + durations.push(duration); + } + // but update all on the page (running entries in list pages) + record.textContent = duration; + } + + if (durations.length === 0) { + return; + } + + if (!this._updateBrowserTitle) { + return; + } + + let title = durations.shift(); + for (const duration of durations.slice(0, 2)) { + title += ' | ' + duration; + } + document.title = title; + } + + _setEntries(entries) { + const hasEntries = entries.length > 0; + + this._menu.style.display = hasEntries ? 'inline-block' : 'none'; if (!hasEntries) { // make sure that template entries in the menu are removed, otherwise they // might still be shown in the browsers title - for (let record of this.menu.querySelectorAll('[data-since]')) { + for (let record of this._menu.querySelectorAll('[data-since]')) { record.dataset['since'] = ''; } } - const menuEmpty = document.querySelector(this.selectorEmpty); + const menuEmpty = document.querySelector(this._selectorEmpty); if (menuEmpty !== null) { menuEmpty.style.display = !hasEntries ? 'inline-block' : 'none'; } - } - setEntries(entries) { - this._toggleMenu(entries.length > 0); + const stop = this._menu.querySelector('.ticktac-stop'); - const template = this.menu.querySelector('[data-template="active-record"]'); - - const label = this.menu.querySelector('a > span.label'); - if (label !== null) { - label.innerText = entries.length === 0 ? '' : entries.length; - } - - if (entries.length === 0) { + if (!hasEntries) { + if (stop) { + stop.accesskey = null; + } return; } - if (template === null) { - this._replaceInNode(this.menu, entries[0]); - } else { - const container = template.parentElement; - container.innerHTML = ''; - - for (let timesheet of entries) { - const newNode = template.cloneNode(true); - container.appendChild(this._replaceInNode(newNode, timesheet)); - } + if (stop) { + stop.accesskey = 's'; } - - this.getContainer().getPlugin('timesheet-duration').updateRecords(); + this._replaceInNode(this._menu, entries[0]); + this._updateDuration(); } _replaceInNode(node, timesheet) { - const date = this.getContainer().getPlugin('date'); + const date = this.getDateUtils(); const allReplacer = node.querySelectorAll('[data-replacer]'); - for (let node of allReplacer) { - const replacerName = node.dataset['replacer']; + for (let link of allReplacer) { + const replacerName = link.dataset['replacer']; if (replacerName === 'url') { - node.href = this.attributes['href'].replace('000', timesheet.id); + link.href = this.attributes['href'].replace('000', timesheet.id); } else if (replacerName === 'activity') { - node.innerText = timesheet.activity.name; + link.innerText = timesheet.activity.name; } else if (replacerName === 'project') { - node.innerText = timesheet.project.name; + link.innerText = timesheet.project.name; } else if (replacerName === 'customer') { - node.innerText = timesheet.project.customer.name; + link.innerText = timesheet.project.customer.name; } else if (replacerName === 'duration') { - node.dataset['since'] = timesheet.begin; - node.innerText = date.formatDuration(timesheet.duration); + link.dataset['since'] = timesheet.begin; + link.innerText = date.formatDuration(timesheet.duration); } } - - return node; } reloadActiveRecords() { - const self = this; - const API= this.getContainer().getPlugin('api'); + /** @type {KimaiAPI} API */ + const API = this.getContainer().getPlugin('api'); - API.get(this.attributes['api'], {}, function(result) { - self.setEntries(result); + API.get(this.attributes['api'], {}, (result) => { + this._setEntries(result); }); } diff --git a/assets/js/plugins/KimaiActiveRecordsDuration.js b/assets/js/plugins/KimaiActiveRecordsDuration.js deleted file mode 100644 index 7a5f89f1f..000000000 --- a/assets/js/plugins/KimaiActiveRecordsDuration.js +++ /dev/null @@ -1,78 +0,0 @@ -/* - * This file is part of the Kimai time-tracking app. - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -/*! - * [KIMAI] KimaiActiveRecordsDuration: activate the updates for all active timesheet records on this page - */ - -import KimaiPlugin from '../KimaiPlugin'; - -export default class KimaiActiveRecordsDuration extends KimaiPlugin { - - getId() { - return 'timesheet-duration'; - } - - init() { - this.updateBrowserTitle = !!this.getConfiguration('updateBrowserTitle'); - this.updateRecords(); - const self = this; - const handle = function() { self.updateRecords(); }; - this._updatesHandler = setInterval(handle, 10000); - // this will probably not work as expected, as other event-handler might need longer to update the DOM - document.addEventListener('kimai.timesheetUpdate', handle); - } - - unregisterUpdates() { - clearInterval(this._updatesHandler); - } - - updateRecords() { - let durations = []; - const activeRecords = document.querySelectorAll('[data-since]:not([data-since=""])'); - - if (activeRecords.length === 0) { - if (this.updateBrowserTitle) { - if (document.body.dataset['title'] === undefined) { - this.updateBrowserTitle = false; - } else { - document.title = document.body.dataset['title']; - } - } - return; - } - - const DATE = this.getPlugin('date'); - - for (let record of activeRecords) { - const since = record.dataset['since']; - const duration = DATE.formatDuration(since); - // only use the ones from the menu for the title - if (record.dataset['replacer'] !== undefined && record.dataset['title'] !== null && duration !== '?') { - durations.push(duration); - } - // but update all on the page (running entries in list pages) - record.textContent = duration; - } - - if (durations.length === 0) { - return; - } - - if (!this.updateBrowserTitle) { - return; - } - - let title = durations.shift(); - let prefix = ' | '; - - for (let duration of durations.slice(0, 2)) { - title += prefix + duration; - } - document.title = title; - } -} diff --git a/assets/js/plugins/KimaiAjaxModalForm.js b/assets/js/plugins/KimaiAjaxModalForm.js index 643acc14d..8578cdc59 100644 --- a/assets/js/plugins/KimaiAjaxModalForm.js +++ b/assets/js/plugins/KimaiAjaxModalForm.js @@ -12,70 +12,87 @@ * opening a modal with the content from the URL given in the elements 'data-href' or 'href' attribute */ -import jQuery from 'jquery'; import KimaiReducedClickHandler from "./KimaiReducedClickHandler"; +import { Modal } from 'bootstrap'; export default class KimaiAjaxModalForm extends KimaiReducedClickHandler { constructor(selector) { super(); - this.selector = selector; + this._selector = selector; } - getId() { + getId() + { return 'modal'; } - init() { - const self = this; - this.isDirty = false; + init() + { + this._isDirty = false; - this.modal = jQuery('#remote_form_modal'); - this.modal - .on('hide.bs.modal', function (e) { - if (self.isDirty) { - if (jQuery('#remote_form_modal .modal-body .remote_modal_is_dirty_warning').length === 0) { - const msg = self.getContainer().getTranslation().get('modal.dirty'); - jQuery('#remote_form_modal .modal-body').prepend('

' + msg + '

'); - } - e.preventDefault(); - return; + const modalElement = this._getModalElement(); + if (modalElement === null) { + return; + } + + modalElement.addEventListener('hide.bs.modal', (event) => { + if (this._isDirty) { + if (modalElement.querySelector('.modal-body .remote_modal_is_dirty_warning') === null) { + const msg = this.translate('modal.dirty'); + const temp = document.createElement('div'); + temp.innerHTML = '

' + msg + '

'; + modalElement.querySelector('.modal-body').prepend(temp.firstElementChild); } - jQuery(self._getFormIdentifier()).off('change', self._isDirtyHandler); - self.isDirty = false; - self.getContainer().getPlugin('event').trigger('modal-hide'); - }) - .on('hidden.bs.modal', function () { - // kill all references, so GC can kick in - self.getContainer().getPlugin('form').destroyForm(self._getFormIdentifier()); - jQuery('#remote_form_modal .modal-body').replaceWith(''); - }) - .on('show.bs.modal', function () { - self.getContainer().getPlugin('event').trigger('modal-show'); - }); + event.preventDefault(); + return; + } + this._isDirty = false; + document.dispatchEvent(new Event('modal-hide')); + }); - this._addClickHandler(this.selector, function(href) { - self.openUrlInModal(href); + modalElement.addEventListener('hidden.bs.modal', () => { + // kill all references, so GC can kick in + this.getContainer().getPlugin('form').destroyForm(this._getFormIdentifier()); + modalElement.querySelector('.modal-body').replaceWith(''); + }); + + modalElement.addEventListener('show.bs.modal', () => { + document.dispatchEvent(new Event('modal-show')); + }); + + this.addClickHandler(this._selector, (href) => { + this.openUrlInModal(href); }); } - openUrlInModal(url, errorHandler) { - const self = this; + _getModal() + { + return Modal.getOrCreateInstance(this._getModalElement()) + } - if (errorHandler === undefined) { - errorHandler = function(xhr, err) { - if (xhr.status === undefined || xhr.status !== 403) { - window.location = url; - } - }; - } + openUrlInModal(url) + { + const headers = new Headers(); + headers.append('X-Requested-With', 'Kimai-Modal'); - jQuery.ajax({ - url: url, - success: function(html) { - self._openFormInModal(html); - }, - error: errorHandler + this.fetch(url, { + method: 'GET', + redirect: 'follow', + headers: headers + }) + .then(response => { + if (!response.ok) { + window.location = url; + return; + } + + return response.text().then(html => { + this._openFormInModal(html); + }); + }) + .catch(() => { + window.location = url; }); } @@ -85,157 +102,185 @@ export default class KimaiAjaxModalForm extends KimaiReducedClickHandler { * @returns {string} * @private */ - _getFormIdentifier() { + _getFormIdentifier() + { return '#remote_form_modal .modal-content form'; } - _openFormInModal(html) { - const self = this; + /** + * @returns {HTMLElement|null} + * @private + */ + _getModalElement() + { + return document.getElementById('remote_form_modal'); + } - let formIdentifier = this._getFormIdentifier(); - // if any of these is found in a response, the form will be re-displayed - let flashErrorIdentifier = 'div.alert-error'; - // messages to show above the form - let flashMessageIdentifier = 'div.alert'; - let form = jQuery(formIdentifier); - let remoteModal = this.modal; + /** + * @param {Element|ChildNode} node + * @returns {Element} + * @private + */ + _makeScriptExecutable(node) { + if (node.tagName !== undefined && node.tagName === 'SCRIPT') { + const script = document.createElement('script'); + script.text = node.innerHTML; + node.parentNode.replaceChild(script, node); + } else { + for (const child of node.childNodes) { + this._makeScriptExecutable(child); + } + } - // will be (re-)activated later - form.off('submit'); + return node; + } + + _openFormInModal(html) + { + const formIdentifier = this._getFormIdentifier(); + let remoteModal = this._getModalElement(); + const newFormHtml = document.createElement('div'); + newFormHtml.innerHTML = html; + const newModalContent = this._makeScriptExecutable(newFormHtml.querySelector('#form_modal .modal-content')); // load new form from given content - if (jQuery(html).find('#form_modal .modal-content').length > 0) { - // Support changing modal importance/types - remoteModal.on('hidden.bs.modal', function () { - if (remoteModal.hasClass('modal-danger')) { - remoteModal.removeClass('modal-danger'); - } - }); - - if (jQuery(html).find('#form_modal').hasClass('modal-danger')) { - remoteModal.addClass('modal-danger'); - } - + if (newModalContent !== null) { // Support changing modal sizes - let modalDialog = remoteModal.find('.modal-dialog'); - let largeModal = jQuery(html).find('.modal-dialog').hasClass('modal-lg'); - if (largeModal && !modalDialog.hasClass('modal-lg')) { - modalDialog.addClass('modal-lg'); - } - if (!largeModal && modalDialog.hasClass('modal-lg')) { - modalDialog.removeClass('modal-lg'); + let modalDialog = remoteModal.querySelector('.modal-dialog'); + let largeModal = newFormHtml.querySelector('.modal-dialog').classList.contains('modal-lg'); + + if (largeModal && !modalDialog.classList.contains('modal-lg')) { + modalDialog.classList.toggle('modal-lg'); } - jQuery('#remote_form_modal .modal-content').replaceWith( - jQuery(html).find('#form_modal .modal-content') - ); + if (!largeModal && modalDialog.classList.contains('modal-lg')) { + modalDialog.classList.toggle('modal-lg'); + } - jQuery('#remote_form_modal [data-dismiss=modal]').on('click', function() { - self.isDirty = false; + remoteModal.querySelector('.modal-content').replaceWith(newModalContent); + [].slice.call(remoteModal.querySelectorAll('[data-bs-dismiss="modal"]')).map((element) => { + element.addEventListener('click', () => { + this._isDirty = false; + this._getModal().hide(); + }); }); // activate new loaded widgets - self.getContainer().getPlugin('form').activateForm(formIdentifier); + this.getContainer().getPlugin('form').activateForm(formIdentifier); } // show error flash messages - let flashMessages = jQuery(html).find(flashMessageIdentifier); - if (flashMessages.length > 0) { - jQuery('#remote_form_modal .modal-body').prepend(flashMessages); + let flashMessages = newFormHtml.querySelector('div.alert'); + if (flashMessages !== null) { + remoteModal.querySelector('.modal-body').prepend(flashMessages); } - // ----------------------------------------------------------------------- - // a fix for firefox focus problems with datepicker in modal - // see https://github.com/kimai/kimai/issues/618 - let enforceModalFocusFn = jQuery.fn.modal.Constructor.prototype.enforceFocus; - jQuery.fn.modal.Constructor.prototype.enforceFocus = function() {}; - remoteModal.on('hidden.bs.modal', function () { - jQuery.fn.modal.Constructor.prototype.enforceFocus = enforceModalFocusFn; - }); - // ----------------------------------------------------------------------- - - remoteModal.modal('show'); - // the new form that was loaded via ajax - form = jQuery(formIdentifier); + const form = document.querySelector(formIdentifier); - this._isDirtyHandler = function(e) { - self.isDirty = true; - } - form.on('change', this._isDirtyHandler); + form.addEventListener('change', () => { + this._isDirty = true; + }); // click handler for modal save button, to send forms via ajax - form.on('submit', function(event) { - // if the form has a target, we let the normal HTML flow happen - if (form.attr('target') !== undefined) { - return true; - } + form.addEventListener('submit', this._getEventHandler()); - // otherwise we do some AJAX magic to process the form in the background - const btn = jQuery(formIdentifier + ' button[type=submit]').button('loading'); - const eventName = form.attr('data-form-event'); - const events = self.getContainer().getPlugin('event'); - const alert = self.getContainer().getPlugin('alert'); + this._getModal().show(); + } - event.preventDefault(); - event.stopPropagation(); + _getEventHandler() + { + if (this.eventHandler === undefined) { + this.eventHandler = (event) => { + const form = event.target; - jQuery.ajax({ - url: form.attr('action'), - type: form.attr('method'), - data: form.serialize(), - success: function(html) { - btn.button('reset'); - let hasFieldError = jQuery(html).find('#form_modal .modal-content .has-error').length > 0; - let hasFormError = jQuery(html).find('#form_modal .modal-content ul.list-unstyled li.text-danger').length > 0; - let hasFlashError = jQuery(html).find(flashErrorIdentifier).length > 0; - - if (hasFieldError || hasFormError || hasFlashError) { - self._openFormInModal(html); - } else { - events.trigger(eventName); - - // try to find form defined messages first ... - let msg = form.attr('data-msg-success'); - if (msg === null || msg === undefined) { - // ... but if none was available, check the response to find server rendered flash-message - let flashMessage = jQuery(html).find('section.content div.row div.alert.alert-success'); - if (flashMessage.length > 0) { - let flashContent = flashMessage.contents(); - if (flashContent.length === 3) { - msg = flashContent[2].textContent; - } - } - } - - // ... and if even that is not available, we use a generic fallback message - if (msg === null || msg === undefined) { - msg = 'action.update.success'; - } - self.isDirty = false; - remoteModal.modal('hide'); - alert.success(msg); - } - return false; - }, - error: function(xhr, err) { - let message = form.attr('data-msg-error'); - if (message === null || message === undefined) { - message = 'action.update.error'; - } - if (xhr.responseJSON && xhr.responseJSON.message) { - err = xhr.responseJSON.message; - } else if (xhr.status && xhr.statusText) { - err = '[' + xhr.status +'] ' + xhr.statusText; - } - alert.error(message, err); - // this is useful for changing form fields and retrying to save (and in development to test form changes) - setTimeout(function() { - btn.button('reset'); - }, 1500); + // if the form has a target, we let the normal HTML flow happen + if (form.target !== undefined && form.target !== '') { + return true; } - }); - }); + + // otherwise we do some AJAX magic to process the form in the background + /** @type {HTMLButtonElement} btn */ + const btn = document.querySelector(this._getFormIdentifier() + ' button[type=submit]'); + btn.textContent = btn.textContent + ' …'; + btn.disabled = true; + + const eventName = form.dataset['formEvent']; + /** @type {KimaiEvent} alert */ + const events = this.getContainer().getPlugin('event'); + /** @type {KimaiAlert} alert */ + const alert = this.getContainer().getPlugin('alert'); + + event.preventDefault(); + event.stopPropagation(); + + const headers = new Headers(); + headers.append('X-Requested-With', 'Kimai-Modal'); + const options = {headers: headers}; + + this.fetchForm(form, options) + .then(response => { + response.text().then((html) => { + /** @type {HTMLDivElement} responseHtml */ + const responseHtml = document.createElement('div'); + responseHtml.innerHTML = html; + let hasFieldError = false; + let hasFormError = false; + let hasFlashError = false; + + // button must be re-enabled anyway + btn.textContent = btn.textContent.replace(' …', ''); + btn.disabled = false; + + // if the request was successful, there will be no form + /** @type {Element} modalContent */ + const modalContent = responseHtml.querySelector('#form_modal .modal-content'); + if (modalContent !== null) { + hasFieldError = modalContent.querySelector('.is-invalid') !== null; + if (!hasFieldError) { + // happens when an error occurs for a "hidden or non-classical" form element e.g. creating team without users + hasFieldError = modalContent.querySelector('.invalid-feedback') !== null; + } + hasFormError = modalContent.querySelector('ul.list-unstyled li.text-danger') !== null; + hasFlashError = responseHtml.querySelector('div.alert-danger') !== null; + } + + if (hasFieldError || hasFormError || hasFlashError) { + this._openFormInModal(html); + } else { + events.trigger(eventName); + + // try to find form defined message first, but + let msg = form.dataset['msgSuccess']; + // if that is not available: use a generic fallback message + if (msg === null || msg === undefined || msg === '') { + msg = 'action.update.success'; + } + this._isDirty = false; + this._getModal().hide(); + alert.success(msg); + } + }); + }) + .catch(error => { + let message = form.dataset['msgError']; + if (message === null || message === undefined || message === '') { + message = 'action.update.error'; + } + + alert.error(message, error.message); + + // this is useful for changing form fields and retrying to save (and in development to test form changes) + setTimeout(() =>{ + // critical error, allow to re-submit? + btn.textContent = btn.textContent.replace(' …', ''); + btn.disabled = false; + }, 1500); + }); + }; + } + + return this.eventHandler; } } diff --git a/assets/js/plugins/KimaiAlert.js b/assets/js/plugins/KimaiAlert.js index 5ef2a15ef..c29276f0a 100644 --- a/assets/js/plugins/KimaiAlert.js +++ b/assets/js/plugins/KimaiAlert.js @@ -9,108 +9,261 @@ * [KIMAI] KimaiAlert: notifications for Kimai */ -import Swal from 'sweetalert2' import KimaiPlugin from "../KimaiPlugin"; +import {Modal, Toast} from "bootstrap"; export default class KimaiAlert extends KimaiPlugin { + /** + * @return {string} + */ getId() { return 'alert'; } /** * @param {string} title - * @param {string|array} message + * @param {string|array|undefined} message */ error(title, message) { - const translation = this.getContainer().getTranslation(); + const translation = this.getTranslation(); if (translation.has(title)) { title = translation.get(title); } - if (translation.has(message)) { - message = translation.get(message); + title = title.replace('%reason%', ''); + + if (message === undefined) { + message = null; } - if (Array.isArray(message)) { - Swal.fire({ - icon: 'error', - title: title.replace('%reason%', ''), - html: message.join('
'), - }); - } else { - Swal.fire({ - icon: 'error', - title: title.replace('%reason%', ''), - text: message, - }); + if (message !== null) { + if (translation.has(message)) { + message = translation.get(message); + } + if (Array.isArray(message)) { + message = message.join('
'); + } } + + const id = 'alert_global_error'; + const oldModalElement = document.getElementById(id); + if (oldModalElement !== null) { + Modal.getOrCreateInstance(oldModalElement).hide(); + } + + const html = ` + + `; + + this._showModal(html); } + /** + * @param {string} message + */ warning(message) { this._show('warning', message); } + /** + * @param {string} message + */ success(message) { this._toast('success', message); } + /** + * @param {string} message + */ info(message) { this._show('info', message); } - _show(type, message) { - const translation = this.getContainer().getTranslation(); + /** + * @param {string} html + * @private + */ + _showModal(html) { + const container = document.body; + const template = document.createElement('template'); + template.innerHTML = html.trim(); + const element = template.content.firstChild; + container.appendChild(element); - if (translation.has(message)) { - message = translation.get(message); - } - - Swal.fire({ - icon: type, - title: message, - }); - } - - _toast(type, message) { - const translation = this.getContainer().getTranslation(); - - if (translation.has(message)) { - message = translation.get(message); - } - - Swal.fire({ - timer: 2000, - timerProgressBar: true, - toast: true, - position: 'top', - showConfirmButton: false, - icon: type, - title: message, + const modal = new Modal(element); + element.addEventListener('hidden.bs.modal', function () { + container.removeChild(element); }); + modal.show(); } /** - * Callback receives a value and needs to decide what should happen with it + * @param {string} type + * @param {string} message + * @private + */ + _show(type, message) { + const translation = this.getTranslation(); + + if (translation.has(message)) { + message = translation.get(message); + } + + const html = ` + + `; + + this._showModal(html); + } + + /** + * @param {string} type + * @return {string} + * @private + */ + _mapClass(type) { + if (type === 'info' || type === 'success' || type === 'warning' || type === 'danger') { + return type; + } else if (type === 'error') { + return 'danger'; + } + + return 'primary'; + } + + /** + * @param type + * @param message + * @private + */ + _toast(type, message) { + const translation = this.getTranslation(); + + if (translation.has(message)) { + message = translation.get(message); + } + + let icon = ''; + + if (type === 'success') { + icon = ''; + } else if (type === 'warning') { + icon = ''; + } else if (type === 'danger' || type === 'error') { + icon = ''; + } + + const html = + ``; + + const container = document.getElementById('toast-container'); + const template = document.createElement('template'); + + template.innerHTML = html.trim(); + const element = template.content.firstChild; + container.appendChild(element); + + const toast = new Toast(element); + element.addEventListener('hidden.bs.toast', function () { + container.removeChild(element); + }) + toast.show(); + } + + /** + * Callback receives a bool value (true = confirm, false = cancel / close without action). * * @param message * @param callback */ question(message, callback) { - const translation = this.getContainer().getTranslation(); + const translation = this.getTranslation(); if (translation.has(message)) { message = translation.get(message); } - Swal.fire({ - title: message, - icon: 'question', - showCancelButton: true, - confirmButtonText: translation.get('confirm'), - cancelButtonText: translation.get('cancel') - }).then((result) => { - callback(result.value); - }); - } + const css = this._mapClass('info'); + const html = ` + + `; + const container = document.body; + const template = document.createElement('template'); + template.innerHTML = html.trim(); + const element = template.content.firstChild; + container.appendChild(element); + element.querySelector('.question-confirm').addEventListener('click', () => { + callback(true); + }); + element.querySelector('.question-cancel').addEventListener('click', () => { + callback(false); + }); + + const modal = new Modal(element); + element.addEventListener('hidden.bs.modal', () => { + container.removeChild(element); + }); + modal.show(); + } } diff --git a/assets/js/plugins/KimaiAlternativeLinks.js b/assets/js/plugins/KimaiAlternativeLinks.js index 7e2d955be..9e01a1158 100644 --- a/assets/js/plugins/KimaiAlternativeLinks.js +++ b/assets/js/plugins/KimaiAlternativeLinks.js @@ -12,18 +12,17 @@ * redirecting to the URL given in the elements 'data-href' or 'href' attribute */ -import jQuery from 'jquery'; import KimaiReducedClickHandler from "./KimaiReducedClickHandler"; export default class KimaiAlternativeLinks extends KimaiReducedClickHandler { constructor(selector) { super(); - this.selector = selector; + this._selector = selector; } init() { - this._addClickHandler(this.selector, function(href) { + this.addClickHandler(this._selector, function(href) { window.location = href; }); } diff --git a/assets/js/plugins/KimaiAutocomplete.js b/assets/js/plugins/KimaiAutocomplete.js deleted file mode 100644 index afd00d52d..000000000 --- a/assets/js/plugins/KimaiAutocomplete.js +++ /dev/null @@ -1,106 +0,0 @@ -/* - * This file is part of the Kimai time-tracking app. - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -import jQuery from 'jquery'; -import KimaiPlugin from "../KimaiPlugin"; - -/** - * Supporting auto-complete fields via API. - * Currently used for timesheet tagging in toolbar and edit dialogs. - */ -export default class KimaiAutocomplete extends KimaiPlugin { - - constructor(selector) { - super(); - this.selector = selector; - } - - init() { - this.minChars = this.getConfiguration('autoComplete'); - } - - getId() { - return 'autocomplete'; - } - - splitTagList(val) { - return val.split(/,\s*/); - } - - extractLastTag(term) { - return this.splitTagList(term).pop(); - } - - activateAutocomplete(selector) { - const self = this; - - jQuery(selector + ' ' + this.selector).each(function(index) { - const currentField = jQuery(this); - const apiUrl = currentField.attr('data-autocomplete-url'); - const API = self.getContainer().getPlugin('api'); - - currentField - // don't navigate away from the field on tab when selecting an item - .on("keydown", function (event) { - if (event.keyCode === jQuery.ui.keyCode.TAB && - jQuery(this).autocomplete("instance").menu.active) { - event.preventDefault(); - } - }) - .autocomplete({ - source: function (request, response) { - const lastEntry = self.extractLastTag(request.term); - API.get(apiUrl, {'name': lastEntry}, function(data){ - response(data); - }); - }, - search: function () { - // custom minLength - var term = self.extractLastTag(this.value); - if (term.length < self.minChars) { - return false; - } - }, - focus: function () { - // prevent value inserted on focus - return false; - }, - select: function (event, ui) { - var terms = self.splitTagList(this.value); - - // remove the current input - terms.pop(); - - // check if selected tag is already in list - if (!terms.includes(ui.item.value)) { - // add the selected item - terms.push(ui.item.value); - } - // add placeholder to get the comma-and-space at the end - terms.push(""); - - this.value = terms.join(", "); - - $(this).trigger('change'); - - return false; - } - } - ) - ; - }); - } - - destroyAutocomplete(selector) { - jQuery(selector + ' ' + this.selector).each(function(index) { - const currentField = jQuery(this); - currentField.autocomplete("destroy"); - currentField.removeData('autocomplete'); - }); - } - -} diff --git a/assets/js/plugins/KimaiConfirmationLink.js b/assets/js/plugins/KimaiConfirmationLink.js index 267ff757c..53c2ffd45 100644 --- a/assets/js/plugins/KimaiConfirmationLink.js +++ b/assets/js/plugins/KimaiConfirmationLink.js @@ -19,15 +19,14 @@ export default class KimaiConfirmationLink extends KimaiPlugin { constructor(selector) { super(); - this.selector = selector; + this._selector = selector; } init() { - const self = this; - document.addEventListener('click', function(event) { + document.addEventListener('click', (event) => { let target = event.target; - while (target !== null && !target.matches('body')) { - if (target.classList.contains(self.selector)) { + while (target !== null && typeof target.matches === "function" && !target.matches('body')) { + if (target.classList.contains(this._selector)) { const attributes = target.dataset; // is this a link? @@ -44,7 +43,7 @@ export default class KimaiConfirmationLink extends KimaiPlugin { } if (attributes.question !== undefined) { - self.getContainer().getPlugin('alert').question(attributes.question, function(value) { + this.getContainer().getPlugin('alert').question(attributes.question, function(value) { if (value) { if (form === null) { document.location = url; diff --git a/assets/js/plugins/KimaiDatatable.js b/assets/js/plugins/KimaiDatatable.js index 03e7a20f3..d861f93d6 100644 --- a/assets/js/plugins/KimaiDatatable.js +++ b/assets/js/plugins/KimaiDatatable.js @@ -9,15 +9,15 @@ * [KIMAI] KimaiDatatable: handles functionality for the datatable */ -import jQuery from 'jquery'; import KimaiPlugin from "../KimaiPlugin"; +import KimaiContextMenu from "../widgets/KimaiContextMenu"; export default class KimaiDatatable extends KimaiPlugin { constructor(contentAreaSelector, tableSelector) { super(); - this.contentArea = contentAreaSelector; - this.selector = tableSelector; + this._contentArea = contentAreaSelector; + this._selector = tableSelector; } getId() { @@ -25,24 +25,21 @@ export default class KimaiDatatable extends KimaiPlugin { } init() { - const dataTable = document.querySelector(this.selector); + const dataTable = document.querySelector(this._selector); // not every page contains a dataTable if (dataTable === null) { return; } - const attributes = dataTable.dataset; - const events = attributes['reloadEvent']; - - this.fixDropdowns(); + this.registerContextMenu(this._selector); + const events = dataTable.dataset['reloadEvent']; if (events === undefined) { return; } - const self = this; - const handle = function() { self.reloadDatatable(); }; + const handle = () => { this.reloadDatatable(); }; for (let eventName of events.split(' ')) { document.addEventListener(eventName, handle); @@ -52,55 +49,49 @@ export default class KimaiDatatable extends KimaiPlugin { document.addEventListener('filter-change', handle); } - reloadDatatable() { - const self = this; - const contentArea = this.contentArea; - const durations = this.getContainer().getPlugin('timesheet-duration'); - const toolbarSelector = this.getContainer().getPlugin('toolbar').getSelector(); - - const form = jQuery(toolbarSelector); - let loading = '
'; - jQuery(contentArea).append(loading); - - // remove the empty fields to prevent errors - let formData = jQuery(toolbarSelector + ' :input') - .filter(function(index, element) { - return jQuery(element).val() !== ''; - }) - .serialize(); - - jQuery.ajax({ - url: form.attr('action'), - type: form.attr('method'), - data: formData, - success: function(html) { - jQuery(contentArea).replaceWith( - jQuery(html).find(contentArea) - ); - durations.updateRecords(); - self.fixDropdowns(); - }, - error: function(xhr, err) { - form.submit(); - } - }); - + /** + * @param {string} selector + * @private + */ + registerContextMenu(selector) + { + KimaiContextMenu.createForDataTable(selector); } - /** - * show dropdown menu upwards, if it is outside the visible viewport - */ - fixDropdowns() { - const docHeight = jQuery(document).height(); - jQuery(this.selector + ' [data-toggle=dropdown]').each(function() { - const parent = jQuery(this).parent(); - const menu = parent.find('.dropdown-menu'); + reloadDatatable() + { + const toolbarSelector = this.getContainer().getPlugin('toolbar').getSelector(); - if (parent && menu) { - if ((parent.offset().top + parent.outerHeight() + menu.outerHeight()) > docHeight) { - parent.addClass('dropup').removeClass('dropdown'); - } - } + /** @type {HTMLFormElement} form */ + const form = document.querySelector(toolbarSelector); + const callback = (text) => { + const temp = document.createElement('div'); + temp.innerHTML = text; + const newContent = temp.querySelector(this._contentArea); + document.querySelector(this._contentArea).replaceWith(newContent); + this.registerContextMenu(this._selector); + document.dispatchEvent(new Event('kimai.reloadedContent')); + }; + + document.dispatchEvent(new CustomEvent('kimai.reloadContent', {detail: this._contentArea})); + + if (form === null) { + this.fetch(document.location) + .then(response => { + response.text().then(callback); + }) + .catch(() => { + document.location.reload(); + }); + return; + } + + this.fetchForm(form) + .then(response => { + response.text().then(callback); + }) + .catch(() => { + form.submit(); }); } } diff --git a/assets/js/plugins/KimaiDatatableColumnView.js b/assets/js/plugins/KimaiDatatableColumnView.js index cac62a724..0566855d8 100644 --- a/assets/js/plugins/KimaiDatatableColumnView.js +++ b/assets/js/plugins/KimaiDatatableColumnView.js @@ -9,8 +9,6 @@ * [KIMAI] KimaiDatatableColumnView: manages the visibility of data-table columns in cookies */ -import Cookies from 'js-cookie'; -import jQuery from 'jquery'; import KimaiPlugin from "../KimaiPlugin"; export default class KimaiDatatableColumnView extends KimaiPlugin { @@ -29,80 +27,110 @@ export default class KimaiDatatableColumnView extends KimaiPlugin { if (dataTable === null) { return; } - this.id = dataTable.getAttribute(this.dataAttribute); - this.modal = document.getElementById('modal_' + this.id); - this.bindButtons(); - } - - bindButtons() { - let self = this; - this.modal.querySelector('button[data-type=save]').addEventListener('click', function() { - self.saveVisibility(); + this._id = dataTable.getAttribute(this.dataAttribute); + this._modal = document.getElementById('modal_' + this._id); + this._modal.addEventListener('show.bs.modal', () => { + this._evaluateCheckboxes(); }); - this.modal.querySelector('button[data-type=reset]').addEventListener('click', function() { - self.resetVisibility(); + this._modal.querySelector('button[data-type=save]').addEventListener('click', () => { + this._saveVisibility(); }); - for (let checkbox of this.modal.querySelectorAll('form input[type=checkbox]')) { - checkbox.addEventListener('click', function () { - self.changeVisibility(checkbox.getAttribute('name'), checkbox.checked); + this._modal.querySelector('button[data-type=reset]').addEventListener('click', (event) => { + this._resetVisibility(event.currentTarget); + }); + this._modal.querySelectorAll('input[name=datatable_profile]').forEach(element => { + element.addEventListener('change', () => { + const form = this._modal.getElementsByTagName('form')[0]; + this.fetchForm(form, {}, element.getAttribute('data-href')) + .then(() => { + // the local storage is read in the login screen to set a cookie, + // which triggers the session switch in ProfileSubscriber + localStorage.setItem('kimai_profile', element.getAttribute('value')); + document.location.reload(); + }) + .catch(() => { + form.setAttribute('action', element.getAttribute('data-href')); + form.submit(); + }); + }); + }); + for (let checkbox of this._modal.querySelectorAll('form input[type=checkbox]')) { + checkbox.addEventListener('change', () => { + this._changeVisibility(checkbox.getAttribute('name'), checkbox.checked); }); } } - saveVisibility() { - const form = this.modal.getElementsByTagName('form')[0]; - let settings = {}; - for (let checkbox of form.querySelectorAll('input[type=checkbox]')) { - settings[checkbox.getAttribute('name')] = checkbox.checked; + _evaluateCheckboxes() { + const form = this._modal.getElementsByTagName('form')[0]; + const table = document.getElementsByClassName('datatable_' + this._id)[0]; + for (let columnElement of table.getElementsByTagName('th')) { + const fieldName = columnElement.getAttribute('data-field'); + if (fieldName === null) { + continue; + } + const checkbox = form.querySelector('input[name=' + fieldName + ']'); + if (checkbox === null) { + continue; + } + checkbox.checked = window.getComputedStyle(columnElement).display !== 'none'; } - Cookies.set(form.getAttribute('name'), JSON.stringify(settings), {expires: 365, SameSite: 'Strict'}); - jQuery(this.modal).modal('toggle'); } - resetVisibility() { - const form = this.modal.getElementsByTagName('form')[0]; - Cookies.remove(form.getAttribute('name')); - for (let checkbox of form.querySelectorAll('input[type=checkbox]')) { - if (!checkbox.checked) { - checkbox.click(); - } - } - jQuery(this.modal).modal('toggle'); + _saveVisibility() { + const form = this._modal.getElementsByTagName('form')[0]; + + this.fetchForm(form) + .then(() => { + document.location.reload(); + }) + .catch(() => { + form.submit(); + }); } - changeVisibility(columnName, checked) { - const tables = document.getElementsByClassName('datatable_' + this.id); - for (let tableBox of tables) { - let column = 0; - let foundColumn = false; - let table = tableBox.getElementsByClassName('dataTable')[0]; - for (let columnElement of table.getElementsByTagName('th')) { - if (columnElement.getAttribute('data-field') === columnName) { - foundColumn = true; - break; + _resetVisibility(button) { + const form = this._modal.getElementsByTagName('form')[0]; + + this.fetchForm(form, {}, button.getAttribute('formaction')) + .then(() => { + document.location.reload(); + }) + .catch(() => { + form.setAttribute('action', button.getAttribute('formaction')); + form.submit(); + }); + } + + _changeVisibility(columnName, checked) { + for (const tableBox of document.getElementsByClassName('datatable_' + this._id)) { + let targetClasses = null; + for (let element of tableBox.getElementsByClassName('col_' + columnName)) { + // only calculate that once and re-use the cached class list + if (targetClasses === null) { + let removeClass = '-none'; + let addClass = 'd-table-cell'; + + if (!checked) { + removeClass = '-table-cell'; + addClass = 'd-none'; + } + + targetClasses = ''; + element.classList.forEach( + function (name, index, listObj) { // eslint-disable-line no-unused-vars + if (name.indexOf(removeClass) === -1) { + targetClasses += ' ' + name; + } + } + ); + + if (targetClasses.indexOf(addClass) === -1) { + targetClasses += ' ' + addClass; + } } - if (columnElement.getAttribute('colspan') !== null) { - console.log('Tables with colspans are not supported!'); - } - - column++; - } - - if (!foundColumn) { - return; - } - - for (let rowElement of table.getElementsByTagName('tr')) { - if (rowElement.children[column] === undefined) { - continue; - } - - if (checked) { - rowElement.children[column].classList.remove('hidden'); - } else { - rowElement.children[column].classList.add('hidden'); - } + element.className = targetClasses; } } } diff --git a/assets/js/plugins/KimaiDatePicker.js b/assets/js/plugins/KimaiDatePicker.js deleted file mode 100644 index d9d315426..000000000 --- a/assets/js/plugins/KimaiDatePicker.js +++ /dev/null @@ -1,72 +0,0 @@ -/* - * This file is part of the Kimai time-tracking app. - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -/*! - * [KIMAI] KimaiDatePicker: single date selects (currently unused) - */ - -import jQuery from 'jquery'; -import KimaiPlugin from '../KimaiPlugin'; - -export default class KimaiDatePicker extends KimaiPlugin { - - constructor(selector) { - super(); - this.selector = selector; - } - - getId() { - return 'date-picker'; - } - - activateDatePicker(selector) { - const TRANSLATE = this.getContainer().getTranslation(); - const DATE_UTILS = this.getContainer().getPlugin('date'); - const firstDow = this.getConfiguration('first_dow_iso') % 7; - - jQuery(selector + ' ' + this.selector).each(function(index) { - let localeFormat = jQuery(this).data('format'); - jQuery(this).daterangepicker({ - singleDatePicker: true, - showDropdowns: true, - autoUpdateInput: false, - drops: 'down', - locale: { - format: localeFormat, - firstDay: firstDow, - applyLabel: TRANSLATE.get('confirm'), - cancelLabel: TRANSLATE.get('cancel'), - customRangeLabel: TRANSLATE.get('customRange'), - daysOfWeek: DATE_UTILS.getWeekDaysShort(), - monthNames: DATE_UTILS.getMonthNames(), - } - }); - - jQuery(this).on('show.daterangepicker', function (ev, picker) { - if (picker.element.offset().top - jQuery(window).scrollTop() + picker.container.outerHeight() + 30 > jQuery(window).height()) { - // "up" is not possible here, because the code is triggered on many mobile phones and the picker then appears out of window - picker.drops = 'auto'; - picker.move(); - } - }); - - jQuery(this).on('apply.daterangepicker', function(ev, picker) { - jQuery(this).val(picker.startDate.format(localeFormat)); - jQuery(this).trigger("change"); - }); - }); - } - - destroyDatePicker(selector) { - jQuery(selector + ' ' + this.selector).each(function(index) { - if (jQuery(this).data('daterangepicker') !== undefined) { - jQuery(this).data('daterangepicker').remove(); - } - }); - } - -} diff --git a/assets/js/plugins/KimaiDateRangePicker.js b/assets/js/plugins/KimaiDateRangePicker.js deleted file mode 100644 index ca86ebb49..000000000 --- a/assets/js/plugins/KimaiDateRangePicker.js +++ /dev/null @@ -1,95 +0,0 @@ -/* - * This file is part of the Kimai time-tracking app. - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -/*! - * [KIMAI] KimaiDateRangePicker: activate the (daterange picker) compound field in toolbar - */ - -import jQuery from 'jquery'; -import KimaiPlugin from '../KimaiPlugin'; -import moment from 'moment'; - -export default class KimaiDateRangePicker extends KimaiPlugin { - - constructor(selector) { - super(); - this.selector = selector; - } - - getId() { - return 'date-range-picker'; - } - - activateDateRangePicker(selector) { - const TRANSLATE = this.getContainer().getTranslation(); - const DATE_UTILS = this.getContainer().getPlugin('date'); - const firstDow = this.getConfiguration('first_dow_iso') % 7; - - jQuery(selector + ' ' + this.selector).each(function(index) { - let localeFormat = jQuery(this).data('format'); - let separator = jQuery(this).data('separator'); - let rangesList = {}; - - rangesList[TRANSLATE.get('today')] = [moment(), moment()]; - rangesList[TRANSLATE.get('yesterday')] = [moment().subtract(1, 'days'), moment().subtract(1, 'days')]; - rangesList[TRANSLATE.get('thisWeek')] = [moment().startOf('isoWeek'), moment().endOf('isoWeek')]; - rangesList[TRANSLATE.get('lastWeek')] = [moment().subtract(1, 'week').startOf('isoWeek'), moment().subtract(1, 'week').endOf('isoWeek')]; - if (firstDow === 0) { // sunday = 0 - rangesList[TRANSLATE.get('thisWeek')] = [moment().startOf('isoWeek').subtract(1, 'day'), moment().endOf('isoWeek').subtract(1, 'day')]; - rangesList[TRANSLATE.get('lastWeek')] = [moment().subtract(1, 'week').startOf('isoWeek').subtract(1, 'day'), moment().subtract(1, 'week').endOf('isoWeek').subtract(1, 'day')]; - } - rangesList[TRANSLATE.get('thisMonth')] = [moment().startOf('month'), moment().endOf('month')]; - rangesList[TRANSLATE.get('lastMonth')] = [moment().subtract(1, 'month').startOf('month'), moment().subtract(1, 'month').endOf('month')]; - rangesList[TRANSLATE.get('thisYear')] = [moment().startOf('year'), moment().endOf('year')]; - rangesList[TRANSLATE.get('lastYear')] = [moment().subtract(1, 'year').startOf('year'), moment().subtract(1, 'year').endOf('year')]; - - jQuery(this).daterangepicker({ - showDropdowns: true, - autoUpdateInput: false, - autoApply: false, - linkedCalendars: true, - drops: 'down', - locale: { - separator: separator, - format: localeFormat, - firstDay: firstDow, - applyLabel: TRANSLATE.get('confirm'), - cancelLabel: TRANSLATE.get('cancel'), - customRangeLabel: TRANSLATE.get('customRange'), - daysOfWeek: DATE_UTILS.getWeekDaysShort(), - monthNames: DATE_UTILS.getMonthNames(), - }, - ranges: rangesList, - alwaysShowCalendars: true - }); - - jQuery(this).on('show.daterangepicker', function (ev, picker) { - if (picker.element.offset().top - jQuery(window).scrollTop() + picker.container.outerHeight() + 30 > jQuery(window).height()) { - // "up" is not possible here, because the code is triggered on many mobile phones and the picker then appears out of window - picker.drops = 'auto'; - picker.move(); - } - }); - - jQuery(this).on('apply.daterangepicker', function(ev, picker) { - jQuery(this).val(picker.startDate.format(localeFormat) + ' - ' + picker.endDate.format(localeFormat)); - jQuery(this).data('begin', picker.startDate.format(localeFormat)); - jQuery(this).data('end', picker.endDate.format(localeFormat)); - jQuery(this).trigger("change"); - }); - }); - } - - destroyDateRangePicker(selector) { - jQuery(selector + ' ' + this.selector).each(function(index) { - if (jQuery(this).data('daterangepicker') !== undefined) { - jQuery(this).data('daterangepicker').remove(); - } - }); - } - -} diff --git a/assets/js/plugins/KimaiDateTimePicker.js b/assets/js/plugins/KimaiDateTimePicker.js deleted file mode 100644 index c4a4a9135..000000000 --- a/assets/js/plugins/KimaiDateTimePicker.js +++ /dev/null @@ -1,75 +0,0 @@ -/* - * This file is part of the Kimai time-tracking app. - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -/*! - * [KIMAI] KimaiDateTimePicker: activate the (datetime picker) field in timesheet edit dialog - */ - -import jQuery from 'jquery'; -import KimaiPlugin from '../KimaiPlugin'; - -export default class KimaiDateTimePicker extends KimaiPlugin { - - constructor(selector) { - super(); - this.selector = selector; - } - - getId() { - return 'date-time-picker'; - } - - activateDateTimePicker(selector) { - const TRANSLATE = this.getContainer().getTranslation(); - const DATE_UTILS = this.getContainer().getPlugin('date'); - const firstDow = this.getConfiguration('first_dow_iso') % 7; - const is24hours = this.getConfiguration('twentyFourHours'); - - jQuery(selector + ' ' + this.selector).each(function(index) { - let localeFormat = jQuery(this).data('format'); - jQuery(this).daterangepicker({ - singleDatePicker: true, - timePicker: true, - timePicker24Hour: is24hours, - showDropdowns: true, - autoUpdateInput: false, - drops: 'down', - locale: { - format: localeFormat, - firstDay: firstDow, - applyLabel: TRANSLATE.get('confirm'), - cancelLabel: TRANSLATE.get('cancel'), - customRangeLabel: TRANSLATE.get('customRange'), - daysOfWeek: DATE_UTILS.getWeekDaysShort(), - monthNames: DATE_UTILS.getMonthNames(), - } - }); - - jQuery(this).on('show.daterangepicker', function (ev, picker) { - if (picker.element.offset().top - jQuery(window).scrollTop() + picker.container.outerHeight() + 30 > jQuery(window).height()) { - // "up" is not possible here, because the code is triggered on many mobile phones and the picker then appears out of window - picker.drops = 'auto'; - picker.move(); - } - }); - - jQuery(this).on('apply.daterangepicker', function(ev, picker) { - jQuery(this).val(picker.startDate.format(localeFormat)); - jQuery(this).trigger("change"); - }); - }); - } - - destroyDateTimePicker(selector) { - jQuery(selector + ' ' + this.selector).each(function(index) { - if (jQuery(this).data('daterangepicker') !== undefined) { - jQuery(this).data('daterangepicker').remove(); - } - }); - } - -} diff --git a/assets/js/plugins/KimaiDateUtils.js b/assets/js/plugins/KimaiDateUtils.js index 2a0d7737d..782050611 100644 --- a/assets/js/plugins/KimaiDateUtils.js +++ b/assets/js/plugins/KimaiDateUtils.js @@ -10,71 +10,241 @@ */ import KimaiPlugin from '../KimaiPlugin'; -import moment from 'moment'; +import { DateTime, Duration } from 'luxon'; export default class KimaiDateUtils extends KimaiPlugin { - getId() { + getId() + { return 'date'; } + init() + { + if (this.getConfigurations().is24Hours()) { + this.timeFormat = 'HH:mm'; + } else { + this.timeFormat = 'hh:mm a'; + } + this.durationFormat = this.getConfiguration('formatDuration'); + this.dateFormat = this.getConfiguration('formatDate'); + } + /** - * @param {string} dateTime + * @see https://moment.github.io/luxon/#/formatting?id=table-of-tokens + * @param {string} format + * @returns {string} + * @private + */ + _parseFormat(format) + { + format = format.replace('DD', 'dd'); + format = format.replace('D', 'd'); + format = format.replace('MM', 'LL'); + format = format.replace('M', 'L'); + format = format.replace('YYYY', 'yyyy'); + format = format.replace('YY', 'yy'); + format = format.replace('A', 'a'); + + return format; + } + + /** + * @param {string} format + * @param {string|Date|null|undefined} dateTime * @returns {string} */ - getFormattedDate(dateTime) { - return moment(dateTime).format(this.getConfiguration('formatDate')); - } + format(format, dateTime) + { + let newDate = null; - getWeekDaysShort() { - return moment.localeData().weekdaysShort(); - } + if (dateTime === null || dateTime === undefined) { + newDate = DateTime.now(); + } else if (dateTime instanceof Date) { + newDate = DateTime.fromJSDate(dateTime); + } else { + newDate = DateTime.fromISO(dateTime); + } - getMonthNames() { - return moment.localeData().months(); - } - - formatDuration(since) { - const duration = moment.duration(moment(new Date()).diff(moment(since))); - - return this.formatMomentDuration(duration); - } - - formatSeconds(seconds) { - const duration = moment.duration('PT' + seconds + 'S'); - - return this.formatMomentDuration(duration); + // using locale english here prevents that that AM/PM is translated to the + // locale variant: e.g. "ko" translates it to 오후 / 오전 + return newDate.toFormat(this._parseFormat(format), { locale: 'en-us' }); } /** - * @param {moment.Duration} duration - * @returns {string|*} + * @param {string|Date} dateTime + * @returns {string} */ - formatMomentDuration(duration) { - const hours = parseInt(duration.asHours()); - const minutes = duration.minutes(); - - return this.formatTime(hours, minutes); + getFormattedDate(dateTime) + { + return this.format(this._parseFormat(this.dateFormat), dateTime); } - formatTime(hours, minutes) { - let format = this.getConfiguration('formatDuration'); + /** + * Returns a "YYYY-MM-DDTHH:mm:ss" formatted string in local time. + * This can take Date objects (e.g. from FullCalendar) and turn them into the correct format. + * + * @param {Date|DateTime} date + * @param {boolean|undefined} isUtc + * @return {string} + */ + formatForAPI(date, isUtc = false) + { + if (date instanceof Date) { + date = DateTime.fromJSDate(date); + } + + if (isUtc === undefined || !isUtc) { + date = date.toUTC(); + } + + return date.toISO({ includeOffset: false, suppressMilliseconds: true }); + } + + /** + * @param {string} date + * @param {string} format + * @return {DateTime} + */ + fromFormat(date, format) + { + // using locale en-us here prevents that Luxon expects the localized + // version of AM/PM (e.g. 오후 / 오전 for locale "ko") + return DateTime.fromFormat(date, this._parseFormat(format), { locale: 'en-us' }); + } + + /** + * @param {string|null} date + * @param {string|null} time + * @return {DateTime} + */ + fromHtml5Input(date, time) + { + date = date ?? ''; + time = time ?? ''; + + if (date === '' && time === '') { + return DateTime.invalid('Empty date and time given'); + } + + if (date !== '' && time !== '') { + date = date + 'T' + time; + } + + return DateTime.fromISO(date); + } + + /** + * @param {string} date + * @param {string} format + * @return {boolean} + */ + isValidDateTime(date, format) + { + return this.fromFormat(date, format).isValid; + } + + /** + * Adds a string like "00:30:00" or "01:15" to a given date. + * + * @param {Date} date + * @param {string} duration + * @return {Date} + */ + addHumanDuration(date, duration) + { + /** @type {DateTime} newDate */ + let newDate = null; + + if (date instanceof Date) { + newDate = DateTime.fromJSDate(date); + } else if (date instanceof DateTime) { + newDate = date; + } else { + throw 'addHumanDuration() needs a JS Date'; + } + + const parsed = DateTime.fromISO(duration); + const today = DateTime.now().startOf('day'); + const timeOfDay = parsed.diff(today); + + return newDate.plus(timeOfDay).toJSDate(); + } + + /** + * @param {string|integer|null} since + * @return {string} + */ + formatDuration(since) + { + let duration = null; + + if (typeof since === 'string') { + duration = DateTime.now().diff(DateTime.fromISO(since)); + } else { + duration = Duration.fromISO('PT' + (since === null ? 0 : since) + 'S'); + } + + return this.formatLuxonDuration(duration); + } + + /** + * @param {integer} seconds + * @return {string} + */ + formatSeconds(seconds) + { + return this.formatLuxonDuration(Duration.fromObject({seconds: seconds})); + } + + /** + * @param {Duration} duration + * @returns {string} + * @private + */ + formatLuxonDuration(duration) + { + duration = duration.shiftTo('hours', 'minutes', 'seconds'); + + return this.formatAsDuration(duration.hours, duration.minutes); + } + + /** + * @param {Date} date + * @param {boolean|undefined} isUtc + * @return {string} + */ + formatTime(date, isUtc = false) + { + let newDate = DateTime.fromJSDate(date); + + if (isUtc === undefined || !isUtc) { + newDate = newDate.toUTC(); + } + + // .utc() is required for calendar + return newDate.toFormat(this.timeFormat); + } + + /** + * TODO remove seconds + * + * @param {int} hours + * @param {int} minutes + * @return {string} + */ + formatAsDuration(hours, minutes) + { + let format = this.durationFormat; if (hours < 0 || minutes < 0) { hours = Math.abs(hours); minutes = Math.abs(minutes); - if (minutes > 0 || hours > 0) { - format = '-' + format; - } + format = '-' + format; } - // special case for hours, as they can overflow the 24h barrier - Kimai does not support days as duration unit - if (hours < 10) { - hours = '0' + hours; - } - - - return format.replace('%h', hours).replace('%m', ('0' + minutes).substr(-2)); + return format.replace('%h', (hours < 10 ? '0' + hours : hours)).replace('%m', ('0' + minutes).slice(-2)); + //return format.replace('%h', (hours < 10 ? '0' + hours : hours)).replace('%m', ('0' + minutes).slice(-2)).replace('%s', ('0' + seconds).slice(-2)); } /** @@ -83,32 +253,52 @@ export default class KimaiDateUtils extends KimaiPlugin { */ getSecondsFromDurationString(duration) { - duration = duration.trim().toUpperCase(); - let momentDuration = moment.duration(NaN); + const luxonDuration = this.parseDuration(duration); - if (duration.indexOf(':') !== -1) { - momentDuration = moment.duration(duration); - } else if (duration.indexOf('.') !== -1 || duration.indexOf(',') !== -1) { - duration = duration.replace(/,/, '.'); - duration = (parseFloat(duration) * 3600).toString(); - momentDuration = moment.duration('PT' + duration + 'S'); - } else if (duration.indexOf('H') !== -1 || duration.indexOf('M') !== -1 || duration.indexOf('S') !== -1) { - /* D for days does not work, because 'PT1H' but with days 'P1D' is used */ - momentDuration = moment.duration('PT' + duration); - } else { - let c = parseInt(duration); - let d = parseInt(duration).toFixed(); - if (!isNaN(c) && duration === d) { - duration = (c * 3600).toString(); - momentDuration = moment.duration('PT' + duration + 'S'); - } - } - - if (!momentDuration.isValid()) { + if (luxonDuration === null || !luxonDuration.isValid) { return 0; } - return momentDuration.asSeconds(); + return luxonDuration.as('seconds'); + } + + /** + * @param {string} duration + * @returns {Duration} + */ + parseDuration(duration) + { + if (duration === undefined || duration === null || duration === '') { + return new Duration({seconds: 0}); + } + + duration = duration.trim().toUpperCase(); + let luxonDuration = null; + + if (duration.indexOf(':') !== -1) { + const [, hours, minutes, seconds] = duration.match(/(\d+):(\d+)(?::(\d+))*/); + luxonDuration = Duration.fromObject({hours: hours, minutes: minutes, seconds: seconds}); + } else if (duration.indexOf('.') !== -1 || duration.indexOf(',') !== -1) { + duration = duration.replace(/,/, '.'); + duration = (parseFloat(duration) * 3600).toString(); + luxonDuration = Duration.fromISO('PT' + duration + 'S'); + } else if (duration.indexOf('H') !== -1 || duration.indexOf('M') !== -1 || duration.indexOf('S') !== -1) { + /* D for days does not work, because 'PT1H' but with days 'P1D' is used */ + luxonDuration = Duration.fromISO('PT' + duration); + } else { + let c = parseInt(duration); + const d = parseInt(duration).toFixed(); + if (!isNaN(c) && duration === d) { + duration = (c * 3600).toString(); + luxonDuration = Duration.fromISO('PT' + duration + 'S'); + } + } + + if (luxonDuration === null || !luxonDuration.isValid) { + return new Duration({seconds: 0}); + } + + return luxonDuration; } } diff --git a/assets/js/plugins/KimaiEscape.js b/assets/js/plugins/KimaiEscape.js index 0b20e4c13..8bdfa0c37 100644 --- a/assets/js/plugins/KimaiEscape.js +++ b/assets/js/plugins/KimaiEscape.js @@ -22,6 +22,10 @@ export default class KimaiEscape extends KimaiPlugin { * @returns {string} */ escapeForHtml(title) { + if (title === undefined || title === null) { + return ''; + } + const tagsToReplace = { '&': '&', '<': '<', @@ -31,5 +35,5 @@ export default class KimaiEscape extends KimaiPlugin { return title.replace(/[&<>]/g, function(tag) { return tagsToReplace[tag] || tag; }); - }; + } } diff --git a/assets/js/plugins/KimaiEvent.js b/assets/js/plugins/KimaiEvent.js index 2abc953a5..82332bee4 100644 --- a/assets/js/plugins/KimaiEvent.js +++ b/assets/js/plugins/KimaiEvent.js @@ -13,18 +13,24 @@ import KimaiPlugin from "../KimaiPlugin"; export default class KimaiEvent extends KimaiPlugin { - getId() { + getId() + { return 'event'; } - trigger(name, details) { - if (name === null || name === undefined) { + /** + * @param {string} name + * @param {string|array|object|null} details + */ + trigger(name, details = null) + { + if (name === '') { return; } - for(let event of name.split(' ')) { + for (const event of name.split(' ')) { let triggerEvent = new Event(event); - if (details !== undefined) { + if (details !== null) { triggerEvent = new CustomEvent(event, {detail: details}); } document.dispatchEvent(triggerEvent); diff --git a/assets/js/plugins/KimaiFetch.js b/assets/js/plugins/KimaiFetch.js new file mode 100644 index 000000000..dc0887323 --- /dev/null +++ b/assets/js/plugins/KimaiFetch.js @@ -0,0 +1,80 @@ +/* + * This file is part of the Kimai time-tracking app. + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +/*! + * [KIMAI] KimaiEscape: sanitize strings + */ + +import KimaiPlugin from "../KimaiPlugin"; + +export default class KimaiFetch extends KimaiPlugin { + + getId() { + return 'fetch'; + } + + /** + * @param {string} url + * @param {object} options + * @returns {Promise} + */ + fetch(url, options = {}) { + if (options.headers === undefined) { + options.headers = new Headers(); + } + options.headers.append('X-Requested-With', 'Kimai'); + + options = {...{ + redirect: 'follow', + }, ...options}; + + return new Promise((resolve, reject) => { + fetch(url, options).then(response => { + if (response.ok) { + if (response.status === 201 && response.headers.has('x-modal-redirect')) { + window.location = response.headers.get('x-modal-redirect'); + return; + } + + // "ok" is only in status code range of 2xx + resolve(response); + return; + } + + let stopPropagation = false; + switch (response.status) { + case 403: { + if (response.headers.has('login-required')) { + const loginUrl = this.getConfiguration('login').toString(); + /** @type {KimaiAlert} alert */ + const alert = this.getContainer().getPlugin('alert'); + alert.question(this.translate('login.required'), (result) => { + if (result === true) { + window.location.replace(loginUrl); + } + }); + stopPropagation = true; + } + break; + } + default: { + console.log('Some error occurred'); + break; + } + } + + if (!stopPropagation) { + reject(response); + } + }) + .catch(error => { + console.log('Error occurred while talking to Kimai backend', error); + reject(error); + }); + }); + } +} diff --git a/assets/js/plugins/KimaiForm.js b/assets/js/plugins/KimaiForm.js index 3fed02505..f0d278268 100644 --- a/assets/js/plugins/KimaiForm.js +++ b/assets/js/plugins/KimaiForm.js @@ -10,35 +10,44 @@ */ import KimaiPlugin from "../KimaiPlugin"; +import KimaiFormPlugin from "../forms/KimaiFormPlugin"; export default class KimaiForm extends KimaiPlugin { - getId() { + getId() + { return 'form'; } - activateForm(formSelector, container) { - this.getContainer().getPlugin('date-range-picker').activateDateRangePicker(formSelector); - this.getContainer().getPlugin('date-time-picker').activateDateTimePicker(formSelector); - this.getContainer().getPlugin('date-picker').activateDatePicker(formSelector); - this.getContainer().getPlugin('autocomplete').activateAutocomplete(formSelector); - this.getContainer().getPlugin('form-select').activateSelectPicker(formSelector, container); + activateForm(formSelector) + { + [].slice.call(document.querySelectorAll(formSelector)).map((form) => { + for (const plugin of this.getContainer().getPlugins()) { + if (plugin instanceof KimaiFormPlugin && plugin.supportsForm(form)) { + plugin.activateForm(form); + } + } + }); } - - destroyForm(formSelector) { - this.getContainer().getPlugin('form-select').destroySelectPicker(formSelector); - this.getContainer().getPlugin('autocomplete').destroyAutocomplete(formSelector); - this.getContainer().getPlugin('date-picker').destroyDatePicker(formSelector); - this.getContainer().getPlugin('date-time-picker').destroyDateTimePicker(formSelector); - this.getContainer().getPlugin('date-range-picker').destroyDateRangePicker(formSelector); + + destroyForm(formSelector) + { + [].slice.call(document.querySelectorAll(formSelector)).map((form) => { + for (const plugin of this.getContainer().getPlugins()) { + if (plugin instanceof KimaiFormPlugin && plugin.supportsForm(form)) { + plugin.destroyForm(form); + } + } + }); } /** * @param {HTMLFormElement} form * @param {Object} overwrites + * @param {boolean} removeEmpty * @returns {string} */ - convertFormDataToQueryString(form, overwrites = {}) + convertFormDataToQueryString(form, overwrites = {}, removeEmpty = false) { let serialized = []; let data = new FormData(form); @@ -48,7 +57,9 @@ export default class KimaiForm extends KimaiPlugin { } for (let row of data) { - serialized.push(encodeURIComponent(row[0]) + "=" + encodeURIComponent(row[1])); + if (!removeEmpty || row[1] !== '') { + serialized.push(encodeURIComponent(row[0]) + "=" + encodeURIComponent(row[1])); + } } return serialized.join('&'); diff --git a/assets/js/plugins/KimaiFormSelect.js b/assets/js/plugins/KimaiFormSelect.js deleted file mode 100644 index 455cf958d..000000000 --- a/assets/js/plugins/KimaiFormSelect.js +++ /dev/null @@ -1,298 +0,0 @@ -/* - * This file is part of the Kimai time-tracking app. - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -/*! - * [KIMAI] KimaiFormSelect: enhanced functionality for HTML select's - */ - -import KimaiPlugin from "../KimaiPlugin"; -import jQuery from "jquery"; - -export default class KimaiFormSelect extends KimaiPlugin { - - constructor(selector) { - super(); - this.selector = selector; - } - - getId() { - return 'form-select'; - } - - init() { - // selects the original value inside select2 dropdowns, as the "reset" event (the updated option) - // is not automatically catched by select2 - jQuery('body').on('reset', 'form', function(event) { - setTimeout(function() { - jQuery(event.target).find(this.selector).trigger('change'); - }, 10); - }); - - const self = this; - - // Function to match the name of the parent and not only the names of the children - // Based on the original matcher function of Select2: https://github.com/select2/select2/blob/5765090318c4d382ae56463cfa25ba8ca7bdd495/src/js/select2/defaults.js#L272 - // More information: https://select2.org/searching | https://github.com/select2/docs/blob/develop/pages/11.searching/docs.md - this.matcher = function (params, data) { - // Always return the object if there is nothing to compare - if (jQuery.trim(params.term) === '') { - return data; - } - - // Check whether options has children - let hasChildren = data.children && data.children.length > 0; - - // Split search param by space to search for all terms and convert all to uppercase - let terms = params.term.toUpperCase().split(' '); - let original = data.text.toUpperCase(); - - // Always return the parent option including its children, when the name matches one of the params - // Check if the text contains all or at least one of the terms - let foundAll = true; - let foundOne = false; - let missingTerms = []; - terms.forEach(function(item, index) { - if (original.indexOf(item) > -1) { - foundOne = true; - } else { - foundAll = false; - missingTerms.push(item); - } - }); - - // If the option element contains all terms, return it - if (foundAll) { - return data; - } - - // Do a recursive check for options with children - if (hasChildren) { - // If the parent already contains one or more search terms, proceed only with the missing ones - // First: Clone the original params object... - let newParams = jQuery.extend(true, {}, params); - if (foundOne) { - newParams.term = missingTerms.join(' '); - } else { - newParams.term = params.term; - } - - // Clone the data object if there are children - // This is required as we modify the object to remove any non-matches - let match = jQuery.extend(true, {}, data); - - // Check each child of the option - for (let c = data.children.length - 1; c >= 0; c--) { - let child = data.children[c]; - - let matches = self.matcher(newParams, child); - - // If there wasn't a match, remove the object in the array - if (matches === null) { - match.children.splice(c, 1); - } - } - - // If any children matched, return the new object - if (match.children.length > 0) { - return match; - } - } - - // If the option or its children do not contain the term, don't return anything - return null; - } - } - - activateSelectPickerByElement(node, container) { - let options = {}; - if (container !== undefined) { - options = { - dropdownParent: jQuery(container), - }; - } - - options = {...options, ...{ - language: this.getConfiguration('locale').replace('_', '-'), - theme: "bootstrap", - matcher: this.matcher, - dropdownAutoWidth: true, - width: "resolve" - }}; - - const element = jQuery(node); - - if (node.dataset['renderer'] !== undefined && node.dataset['renderer'] === 'color') { - const templateResultFunc = function (state) { - return jQuery(' ' + state.text + ''); - }; - - const colorOptions = {...options, ...{ - templateSelection: templateResultFunc, - templateResult: templateResultFunc - }}; - - element.select2(colorOptions); - } else { - element.select2(options); - } - - // this is a bugfix for safari, which does render the dropdown only with correct width upon the second opening - // see https://github.com/select2/select2/issues/4678 - element.on('select2:open', function (ev) { - if (element.data('performing-reopen') === undefined || element.data('performing-reopen') === null) { - element.data('performing-reopen', true); - element.select2('close'); - element.select2('open'); - } - }); - } - - activateSelectPicker(selector, container) { - const self = this; - jQuery(selector + ' ' + this.selector).each(function(i, el) { - self.activateSelectPickerByElement(el, container); - }); - } - - destroySelectPicker(selector) { - jQuery(selector + ' ' + this.selector).select2('destroy'); - } - - updateOptions(selectIdentifier, data) { - let select = jQuery(selectIdentifier); - let emptyOption = jQuery(selectIdentifier + ' option[value=""]'); - const selectedValue = select.val(); - - select.find('option').remove().end().find('optgroup').remove().end(); - - if (emptyOption.length !== 0) { - select.append(this._createOption(emptyOption.text(), '')); - } - - let emptyOpts = []; - let options = []; - let titlePattern = null; - if (select[0] !== undefined && select[0].dataset !== undefined && select[0].dataset['optionPattern'] !== undefined) { - titlePattern = select[0].dataset['optionPattern']; - } - if (titlePattern === null || titlePattern === '') { - titlePattern = '{name}'; - } - - for (const [key, value] of Object.entries(data)) { - if (key === '__empty__') { - for (const entity of value) { - emptyOpts.push(this._createOption(this._getTitleFromPattern(titlePattern, entity), entity.id)); - } - continue; - } - - let optGroup = this._createOptgroup(key); - for (const entity of value) { - optGroup.appendChild(this._createOption(this._getTitleFromPattern(titlePattern, entity), entity.id)); - } - options.push(optGroup); - } - - select.append(options); - select.append(emptyOpts); - - // if available, re-select the previous selected option (mostly usable for global activities) - select.val(selectedValue); - - // pre-select an option if it is the only available one - if (select.val() === '' || select.val() === null) { - const allOptions = select.find('option'); - const optionLength = allOptions.length; - let selectOption = ''; - - if (optionLength === 1) { - selectOption = allOptions[0].value; - } else if (optionLength === 2 && emptyOption.length === 1) { - selectOption = allOptions[1].value; - } - - if (selectOption !== '') { - select.val(selectOption); - } - } - - // if we don't trigger the change, the other selects won't reset - select.trigger('change'); - - // if select2 is active, this will tell the select to refresh - if (select.hasClass('selectpicker')) { - select.trigger('change.select2'); - } - } - - /** - * @param {string} pattern - * @param {array} entity - * @private - */ - _getTitleFromPattern(pattern, entity) { - const DATE_UTILS = this.getPlugin('date'); - const regexp = new RegExp('{[^}]*?}','g'); - let title = pattern; - let match = null; - - while ((match = regexp.exec(pattern)) !== null) { - const field = match[0].substr(1, match[0].length - 2); - let value = entity[field] === undefined ? null : entity[field]; - if ((field === 'start' || field === 'end')) { - if (value === null) { - value = '?'; - } else { - value = DATE_UTILS.getFormattedDate(value); - } - } - - title = title.replace(new RegExp('{' + field + '}', 'g'), value ?? ''); - } - title = title.replace(/- \?-\?/, ''); - title = title.replace(/\r\n|\r|\n/g, ' '); - title = title.substr(0, 110); - - const chars = '- '; - let start = 0, end = title.length; - - while (start < end && chars.indexOf(title[start]) >= 0) { - ++start; - } - - while (end > start && chars.indexOf(title[end - 1]) >= 0) { - --end; - } - - return (start > 0 || end < title.length) ? title.substring(start, end) : title; - } - - /** - * @param {string} label - * @param {string} value - * @returns {HTMLElement} - * @private - */ - _createOption(label, value) { - let option = document.createElement('option'); - option.innerText = label; - option.value = value; - return option; - } - - /** - * @param {string} label - * @returns {HTMLElement} - * @private - */ - _createOptgroup(label) { - let optGroup = document.createElement('optgroup'); - optGroup.label = label; - return optGroup; - } -} diff --git a/assets/js/plugins/KimaiHotkeys.js b/assets/js/plugins/KimaiHotkeys.js new file mode 100644 index 000000000..42aa2c54c --- /dev/null +++ b/assets/js/plugins/KimaiHotkeys.js @@ -0,0 +1,51 @@ +/* + * This file is part of the Kimai time-tracking app. + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +import KimaiPlugin from "../KimaiPlugin"; + +export default class KimaiHotkeys extends KimaiPlugin { + + getId() + { + return 'hotkeys'; + } + + init() + { + // https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent + // https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key + + const selector = '[data-hotkey="ctrl+Enter"]'; + + window.addEventListener('keyup', (ev) => { + if (ev.ctrlKey && ev.key === 'Enter') { + const elements = [...document.querySelectorAll(selector)].filter(element => this.isVisible(element)); + + if (elements.length > 1) { + console.warn('KimaiHotkeys: More than one visible element matches ${selector}. No action triggered.'); + } + + if (elements.length === 1) { + ev.stopPropagation(); + ev.preventDefault(); + + elements[0].click(); + } + } + }) + } + + // adopted from Bootstrap 5.1.1, MIT + isVisible (element) + { + if (!element || element.getClientRects().length === 0) { + return false; + } + + return getComputedStyle(element).getPropertyValue('visibility') === 'visible'; + } +} \ No newline at end of file diff --git a/assets/js/plugins/KimaiMultiUpdateTable.js b/assets/js/plugins/KimaiMultiUpdateTable.js index 5556dfcad..94c2b6431 100644 --- a/assets/js/plugins/KimaiMultiUpdateTable.js +++ b/assets/js/plugins/KimaiMultiUpdateTable.js @@ -10,63 +10,79 @@ */ import KimaiPlugin from '../KimaiPlugin'; -import jQuery from "jquery"; export default class KimaiMultiUpdateTable extends KimaiPlugin { - init() { - const self = this; - - jQuery('body'). - on('change', '#multi_update_all', function(event) { - jQuery('.multi_update_single').prop('checked', jQuery(event.target).prop('checked')); - self.toggleForm(); - }) - .on('change', '.multi_update_single', function(event) { - self.toggleForm(); - }) - .on('change', '#multi_update_table_action', function(event) { - const selectedItem = jQuery('#multi_update_table_action option:selected'); - const selectedVal = selectedItem.val(); + init() + { + if (document.getElementById('multi_update_all') === null) { + return; + } - if (selectedVal === '') { - return; + // we have to attach it to the "page-body" div, because section.content can be replaced + // via KimaiDatable and everything inside will be removed, including event listeners + const element = document.querySelector('div.page-body'); + element.addEventListener('change', (event) => { + if (event.target.matches('#multi_update_all')) { + // the "check all" checkbox in the upper start corner of the table + const checked = event.target.checked; + for (const element of document.querySelectorAll('.multi_update_single')) { + element.checked = checked; } - - const form = jQuery('#multi_update_form form'); - const selectedText = selectedItem.text(); - const ids = self.getSelectedIds(); - const question = form.attr('data-question').replace(/%action%/, selectedText).replace(/%count%/, ids.length); - - self.getContainer().getPlugin('alert').question(question, function(value) { + this._toggleForm(); + event.stopPropagation(); + } else if (event.target.matches('.multi_update_single')) { + // single checkboxes in front of each row + this._toggleForm(); + event.stopPropagation(); + } + }); + + element.addEventListener('click', (event) => { + if (event.target.matches('.multi_update_table_action')) { + const selectedItem = event.target; + const ids = this._getSelectedIds(); + const form = document.getElementById('multi_update_form'); + const question = form.dataset['question'].replace(/%action%/, selectedItem.textContent).replace(/%count%/, ids.length.toString()); + + /** @type {KimaiAlert} ALERT */ + const ALERT = this.getPlugin('alert'); + ALERT.question(question, function(value) { if (value) { - form.attr('action', selectedVal).submit(); - } else { - jQuery('#multi_update_table_action').val('').trigger('change'); + const form = document.getElementById('multi_update_form'); + form.action = selectedItem.dataset['href']; + form.submit(); } }); - }); + } + }); } - getSelectedIds() + _getSelectedIds() { let ids = []; - jQuery('.multi_update_single:checked').each(function(i){ - ids[i] = $(this).val(); - }); + for (const box of document.querySelectorAll('input.multi_update_single:checked')) { + ids.push(box.value); + } return ids; } - toggleForm() + _toggleForm() { - const ids = this.getSelectedIds(); - jQuery('#multi_update_table_entities').val(ids.join(',')); + const ids = this._getSelectedIds(); + document.getElementById('multi_update_table_entities').value = ids.join(','); if (ids.length > 0) { - jQuery('#multi_update_form').show(); + for (const element of document.getElementsByClassName('multi_update_form_hide')) { + element.style.setProperty('display', 'none', 'important'); + } + document.getElementById('multi_update_form').style.display = null;//'block'; } else { - jQuery('#multi_update_form').hide(); + document.getElementById('multi_update_form').style.setProperty('display', 'none', 'important'); + for (const element of document.getElementsByClassName('multi_update_form_hide')) { + element.style.display = null; + } } } diff --git a/assets/js/plugins/KimaiNotification.js b/assets/js/plugins/KimaiNotification.js new file mode 100644 index 000000000..f099b1dc3 --- /dev/null +++ b/assets/js/plugins/KimaiNotification.js @@ -0,0 +1,101 @@ +/* + * This file is part of the Kimai time-tracking app. + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +/*! + * [KIMAI] Notification: notifications for Kimai + */ + +import KimaiPlugin from '../KimaiPlugin'; + +export default class KimaiNotification extends KimaiPlugin { + + getId() + { + return 'notification'; + } + + isSupported() + { + if (!window.Notification) { + return false; + } + + if (Notification.permission === 'denied') { + return false; + } + + return Notification.permission === "granted"; + } + + request(callback) + { + try { + Notification.requestPermission().then((permission) => { + if (permission === "granted") { + callback(true); + } else if (permission === "default") { + callback(null); + } else { + callback(false); + } + }); + } catch (e) { + Notification.requestPermission((permission) => { + if (permission === "granted") { + callback(true); + } else if (permission === "default") { + callback(null); + } else { + callback(false); + } + }); + } + } + + notify(title, message, icon, options) + { + this.request((permission) => { + + if (permission !== true) { + /** @type KimaiAlert */ + const ALERT = this.getPlugin('alert'); + ALERT.info(message); + } + + let opts = { + body: message, + dir: this.getConfigurations().isRTL() ? 'rtl' : 'ltr', + }; + //opts.requireInteraction = true; + //opts.renotify = true; + /* + if (options.tag === undefined) { + opts.tag = 'kimai'; + } + */ + if (icon !== undefined && icon !== null) { + opts.icon = icon; + } + + let nTitle = 'Kimai'; + if (title !== null) { + nTitle = nTitle + ': ' + title; + } + + if (options !== undefined && options !== null) { + opts = { ...opts, ...options}; + } + + const notification = new window.Notification(nTitle, opts); + + notification.onclick = function () { + window.focus(); + notification.close(); + }; + }); + } +} diff --git a/assets/js/plugins/KimaiPauseRecord.js b/assets/js/plugins/KimaiPauseRecord.js deleted file mode 100644 index b91895d2b..000000000 --- a/assets/js/plugins/KimaiPauseRecord.js +++ /dev/null @@ -1,41 +0,0 @@ -/* - * This file is part of the Kimai time-tracking app. - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -/*! - * [KIMAI] KimaiPauseRecord - * - * allows to pause records - * THIS IS JUST A DRAFT FOR THE DOM, IT IS NOT SUPPORTED IN KIMAI ITSELF! - */ - -import jQuery from 'jquery'; -import KimaiPlugin from '../KimaiPlugin'; - -export default class KimaiPauseRecord extends KimaiPlugin { - - constructor(selector) { - super(); - this.selector = selector; - } - - init() { - this.activate(this.selector); - } - - activate(selector) { - jQuery(selector + ' .pull-left i').hover(function () { - let link = jQuery(this).parents('a'); - link.attr('href', link.attr('href').replace('/stop', '/pause')); - jQuery(this).removeClass('fa-stop-circle').addClass('fa-pause-circle').addClass('text-orange'); - },function () { - let link = jQuery(this).parents('a'); - link.attr('href', link.attr('href').replace('/pause', '/stop')); - jQuery(this).removeClass('fa-pause-circle').removeClass('text-orange').addClass('fa-stop-circle'); - }); - } - -} diff --git a/assets/js/plugins/KimaiRecentActivities.js b/assets/js/plugins/KimaiRecentActivities.js index 8211ce073..38d451996 100644 --- a/assets/js/plugins/KimaiRecentActivities.js +++ b/assets/js/plugins/KimaiRecentActivities.js @@ -13,32 +13,23 @@ import KimaiPlugin from '../KimaiPlugin'; export default class KimaiRecentActivities extends KimaiPlugin { - constructor(selector) { - super(); - this.selector = selector; - } - - getId() { + getId() + { return 'recent-activities'; } - init() { - const menu = document.querySelector(this.selector); + init() + { + this.menu = document.querySelector('header .notifications-menu'); // the menu can be hidden if user has no permissions to see it - if (menu === null) { + // or no timesheet was recorded yet + if (this.menu === null || this.menu.dataset['reload'] === undefined) { return; } - const dropdown = menu.querySelector('ul.dropdown-menu'); - - this.attributes = dropdown.dataset; - this.itemList = dropdown.querySelector('li > ul.menu'); - - const self = this; - const handle = function() { self.reloadRecentActivities(); }; - - // don't block initial browser rendering - setTimeout(handle, 500); + const handle = () => { + this._reloadMenu(this.menu.dataset['reload']); + }; document.addEventListener('kimai.recentActivities', handle); document.addEventListener('kimai.timesheetUpdate', handle); @@ -49,45 +40,44 @@ export default class KimaiRecentActivities extends KimaiPlugin { document.addEventListener('kimai.projectDelete', handle); document.addEventListener('kimai.customerUpdate', handle); document.addEventListener('kimai.customerDelete', handle); + + this._attachAddRemoveFavorite(); } - emptyList() { - this.itemList.innerHTML = ''; - } + _attachAddRemoveFavorite() + { + [].slice.call(this.menu.querySelectorAll('a.list-group-item-actions')).map((element) => { + element.addEventListener('click', (event) => { + this._reloadMenu(event.currentTarget.href); - setEntries(entries) { - if (entries.length === 0) { - this.emptyList(); - return; - } + event.preventDefault(); + event.stopPropagation(); - let htmlToInsert = ''; - - for (let timesheet of entries) { - let label = this.attributes['template'] - .replace('%customer%', this.escape(timesheet.project.customer.name)) - .replace('%project%', this.escape(timesheet.project.name)) - .replace('%activity%', this.escape(timesheet.activity.name)) - ; - - htmlToInsert += - `
  • ` + - `` + - ` ${ label }` + - `` + - `
  • `; - } - - this.itemList.innerHTML = htmlToInsert; - } - - reloadRecentActivities() { - const self = this; - const API = this.getContainer().getPlugin('api'); - - API.get(this.attributes['api'], {}, function(result) { - self.setEntries(result); + return false; + }); }); } + _reloadMenu(url) + { + this.fetch(url, {method: 'GET'}) + .then(response => { + if (!response.ok) { + //this.menu.remove(); + return; + } + + return response.text().then(html => { + const newFormHtml = document.createElement('div'); + newFormHtml.innerHTML = html; + this.menu.replaceWith(newFormHtml.firstElementChild); + + this.menu = document.querySelector('header .notifications-menu'); + this._attachAddRemoveFavorite(); + }); + }) + .catch(() => { + //this.menu.remove(); + }); + } } diff --git a/assets/js/plugins/KimaiReducedClickHandler.js b/assets/js/plugins/KimaiReducedClickHandler.js index b1f42861a..73fcbab71 100644 --- a/assets/js/plugins/KimaiReducedClickHandler.js +++ b/assets/js/plugins/KimaiReducedClickHandler.js @@ -9,37 +9,57 @@ * [KIMAI] KimaiReducedClickHandler: abstract class */ -import jQuery from 'jquery'; import KimaiPlugin from "../KimaiPlugin"; export default class KimaiReducedClickHandler extends KimaiPlugin { - _addClickHandler(selector, callback) { - jQuery('body').on('click', selector, function(event) { - // just in case an inner element is editable, than this should not be triggered - if (event.target.parentNode.isContentEditable || event.target.isContentEditable) { + /** + * No _underscore naming for now, as it would be mangled otherwise + * @param selector + * @param callback + */ + addClickHandler(selector, callback) { + document.body.addEventListener('click', (event) => { + // event.currentTarget is ALWAYS the body + + let target = event.target; + while (target !== null) { + const tagName = target.tagName.toUpperCase(); + if (tagName === 'BODY') { + return; + } + + if (target.matches(selector)) { + break; + } + + // when an element is clicked, which can trigger stuff itself, we don't want the event to be processed + if (tagName === 'A' || tagName === 'BUTTON' || tagName === 'INPUT' || tagName === 'LABEL') { + return; + } + + target = target.parentNode; + } + + if (target === null) { return; } - // handles the "click" on table rows or list elements - let target = event.target; - if (event.currentTarget.matches('tr') || event.currentTarget.matches('li')) { - while (target !== null && !target.matches('body')) { - // when an element within the row is clicked, that can trigger stuff itself, we don't want the event to be processed - // don't act if a link, button or form element was clicked - if (target.matches('a') || target.matches ('button') || target.matches ('input')) { - return; - } - target = target.parentNode; - } + // just in case an inner element is editable, then this should not be triggered + if (target.isContentEditable || target.parentNode.isContentEditable) { + return; + } + + if (!target.matches(selector)) { + return; } event.preventDefault(); event.stopPropagation(); - let href = jQuery(this).attr('data-href'); - if (!href) { - href = jQuery(this).attr('href'); + let href = target.dataset['href']; + if (href === undefined || href === null) { + href = target.href; } if (href === undefined || href === null || href === '') { diff --git a/assets/js/plugins/KimaiSelectDataAPI.js b/assets/js/plugins/KimaiSelectDataAPI.js deleted file mode 100644 index ff31c8967..000000000 --- a/assets/js/plugins/KimaiSelectDataAPI.js +++ /dev/null @@ -1,150 +0,0 @@ -/* - * This file is part of the Kimai time-tracking app. - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -/*! - * [KIMAI] KimaiSelectDataAPI: {% endblock %} {% if _back is not same as (false) %} - {{ 'action.back'|trans }} + {{ 'back'|trans({}, 'actions') }} {% endif %} {% if _reset is not same as (false) %} diff --git a/templates/default/_form_delete.html.twig b/templates/default/_form_delete.html.twig index 965f16a57..d1ed6efa9 100644 --- a/templates/default/_form_delete.html.twig +++ b/templates/default/_form_delete.html.twig @@ -1,4 +1,4 @@ -{% embed '@AdminLTE/Widgets/box-widget.html.twig' with {'boxtype': 'danger'} %} +{% embed '@theme/embeds/card.html.twig' with {'boxtype': 'danger'} %} {% block box_before %} {{ form_start(form) }} {% endblock %} @@ -9,7 +9,7 @@ {% block form_body %} {% if used is same as (false) %} {{ 'delete.not_in_use'|trans }} -