diff --git a/demo/assets/dbp-toolkit-demo.html.ejs b/demo/assets/dbp-toolkit-demo.html.ejs
index 108c34ae5b7e7da8f571949ffd36a0204f64dc90..999cc48c62420e9182a43326a2234ac54274da4d 100644
--- a/demo/assets/dbp-toolkit-demo.html.ejs
+++ b/demo/assets/dbp-toolkit-demo.html.ejs
@@ -36,44 +36,6 @@
<link rel="preload" href="<%= getPrivateUrl('fonts/SourceSansPro-Semibold.otf.woff2') %>" as="font" type="font/woff2" crossorigin>
<link rel="preload" href="<%= getPrivateUrl('fonts/SourceSansPro-Bold.otf.woff2') %>" as="font" type="font/woff2" crossorigin>
- <!-- Matomo -->
- <script type="text/javascript">
- var _paq = window._paq || [];
- _paq.push(['setCustomVariable', 1, "GitCommit", "<%= buildInfo.info %>", "visit"]);
- _paq.push(['enableHeartBeatTimer']);
- _paq.push(['disableCookies']);
- _paq.push(['trackPageView']);
- _paq.push(['enableLinkTracking']);
-
- (function() {
- var u="https://analytics.tugraz.at/";
- _paq.push(['setTrackerUrl', u+'matomo.php']);
- _paq.push(['setSiteId', '<%= matomoSiteId %>']);
- var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
- g.type='text/javascript'; g.async=true; g.defer=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
- })();
-
- // track changed locations
- window.addEventListener('locationchanged', function(e) {
- _paq.push(['setReferrerUrl', e.detail.referrerUrl]);
- _paq.push(['setCustomUrl', location.href]);
- // _paq.push(['setDocumentTitle', '']);
- _paq.push(['trackPageView']);
-
- // make Matomo aware of newly added content
- var content = document.getElementById('content');
- _paq.push(['MediaAnalytics::scanForMedia', content]);
- _paq.push(['FormAnalytics::scanForForms', content]);
- _paq.push(['trackContentImpressionsWithinNode', content]);
- });
-
- // track errors
- window.addEventListener('error', function(e) {
- _paq.push(['trackEvent', 'Error', e.error.message + '\n' + e.error.stack]);
- });
- </script>
- <!-- End Matomo Code -->
-
<!-- Font related CSS -->
<style>
body {
@@ -134,6 +96,7 @@
entry-point-url="<%= entryPointURL %>"
base-path="<%= getUrl('') %>"
keycloak-config='{"url": "<%= keyCloakBaseURL %>", "realm": "tugraz", "clientId": "<%= keyCloakClientId %>", "silentCheckSsoRedirectUri": "<%= getUrl('silent-check-sso.html') %>"}'
+ matomo-url="<%= matomoUrl %>" matomo-site-id="<%= matomoSiteId %>"
><dbp-loading-spinner></dbp-loading-spinner></<%= name %>>
<!-- Error handling for too old browsers -->
diff --git a/demo/rollup.config.js b/demo/rollup.config.js
index 0887edd96927ed7008001bb0887fe36fdc02d3bc..d38a39d5b57297c5e353df6f34950807efeec509 100644
--- a/demo/rollup.config.js
+++ b/demo/rollup.config.js
@@ -43,7 +43,8 @@ let keyCloakServer = '';
let keyCloakBaseURL = '';
let keyCloakClientId = '';
let pdfAsQualifiedlySigningServer = '';
-let matomoSiteId = 131;
+const matomoUrl = "https://analytics.tugraz.at/";
+const matomoSiteId = 131;
let useTerser = buildFull;
let useBabel = buildFull;
let checkLicenses = buildFull;
@@ -185,6 +186,7 @@ export default {
keyCloakClientId: keyCloakClientId,
pdfAsQualifiedlySigningServer: pdfAsQualifiedlySigningServer,
environment: build,
+ matomoUrl: matomoUrl,
matomoSiteId: matomoSiteId,
buildInfo: getBuildInfo()
}
diff --git a/packages/app-shell/README.md b/packages/app-shell/README.md
index 56d41014b896f80c342831e440570faddfd84738..de4e81de77017e9e268a6ae8056dd4a2c005e060 100644
--- a/packages/app-shell/README.md
+++ b/packages/app-shell/README.md
@@ -16,9 +16,13 @@ activities. Handles login, language selection, activity switching, menus etc.
- `lang` (optional, default: `de`): set to `de` or `en` for German or English
- example `<dbp-app-shell lang="de" </dbp-app-shell>`
- `src`: The path to a topic metadata file (json)
-- `base-path` (optional, default: `/`: An absolute base path for routing
+- `base-path` (optional, default: `/`): An absolute base path for routing
- `entry-point-url`: Entry point URL to access the API
- `keycloak-config`: An object with the following keys: url, realm, clientId, silentCheckSsoRedirectUri, scope
+- `matomo-url` (optional): set to your *Matomo* server (required only for tracking)
+ - example `<dbp-app-shell matomo-url="https://my-matomo.tld"></dbp-app-shell>`
+- `matomo-site-id` (optional): set to your site id (required only for tracking)
+ - example `<dbp-app-shell matomo-site-id="456789"></dbp-app-shell>`
## Topic Metadata
@@ -38,13 +42,13 @@ activities. Handles login, language selection, activity switching, menus etc.
},
"routing_name": "example",
"activities": [
- {"path": "example.metadata.json", visible: true}
+ {"path": "example.metadata.json", "visible": true}
],
"attributes": []
}
```
-## Activity Metada
+## Activity Metadata
```json
{
@@ -70,15 +74,18 @@ activities. Handles login, language selection, activity switching, menus etc.
```bash
# get the source
-git clone git@gitlab.tugraz.at:dbp/apps/AppShell.git
-cd AppShell
+git clone git@gitlab.tugraz.at:dbp/web-components/toolkit.git
+cd toolkit/packages/app-shell
git submodule update --init
# install dependencies (make sure you have npm version 4+ installed, so symlinks to the git submodules are created automatically)
-npm install
+yarn install
-# constantly build dist/bundle.js and run a local web-server on port 8002
-npm run watch
+# constantly build dist/bundle.js and run a local web-server on port 8002
+yarn run watch
+
+# run tests
+yarn test
```
Jump to <http://localhost:8002> and you should get a Single Sign On login page.
diff --git a/packages/app-shell/package.json b/packages/app-shell/package.json
index c8daf03f3b3420c4392fa037bd1a9398694cb672..d431e42fd6ffedaebadfd68171a98fae6ba954a2 100644
--- a/packages/app-shell/package.json
+++ b/packages/app-shell/package.json
@@ -23,6 +23,7 @@
"rollup-plugin-consts": "^1.0.1",
"rollup-plugin-copy": "^3.1.0",
"rollup-plugin-delete": "^2.0.0",
+ "rollup-plugin-emit-ejs": "^3.1.0",
"rollup-plugin-serve": "^1.0.1"
},
"dependencies": {
@@ -35,7 +36,8 @@
"dbp-common": "^1.0.0",
"dbp-language-select": "^1.0.0",
"dbp-notification": "^1.0.0",
- "dbp-person-profile": "^1.0.0"
+ "dbp-person-profile": "^1.0.0",
+ "dbp-matomo": "^1.0.0"
},
"scripts": {
"build": "npm run build-local",
diff --git a/packages/app-shell/src/app-shell.js b/packages/app-shell/src/app-shell.js
index 4b0911b164f81246a9eeacf8529a673aad165786..6fe7b6dcbf67acd75ed6a8e9590d8ccb56da7f4d 100644
--- a/packages/app-shell/src/app-shell.js
+++ b/packages/app-shell/src/app-shell.js
@@ -15,6 +15,7 @@ import {BuildInfo} from './build-info.js';
import {TUGrazLogo} from './tugraz-logo.js';
import {send as notify} from 'dbp-common/notification';
import {appWelcomeMeta} from './dbp-app-shell-welcome.js';
+import {MatomoElement} from "dbp-matomo/src/matomo";
const i18n = createI18nInstance();
@@ -58,6 +59,10 @@ export class AppShell extends ScopedElementsMixin(LitElement) {
this._updateAuth = this._updateAuth.bind(this);
this._loginStatus = 'unknown';
+ this.matomoUrl = '';
+ this.matomoSiteId = -1;
+ this.matomo = null;
+
this._attrObserver = new MutationObserver(this.onAttributeObserved);
}
@@ -70,6 +75,7 @@ export class AppShell extends ScopedElementsMixin(LitElement) {
'dbp-auth-menu-button': AuthMenuButton,
'dbp-notification': Notification,
'dbp-icon': Icon,
+ 'dbp-matomo': MatomoElement,
};
}
@@ -222,6 +228,8 @@ export class AppShell extends ScopedElementsMixin(LitElement) {
subtitle: { type: String, attribute: false },
description: { type: String, attribute: false },
_loginStatus: { type: Boolean, attribute: false },
+ matomoUrl: { type: String, attribute: "matomo-url" },
+ matomoSiteId: { type: Number, attribute: "matomo-site-id" },
};
}
@@ -248,6 +256,10 @@ export class AppShell extends ScopedElementsMixin(LitElement) {
this.initRouter();
this._bus.subscribe('auth-update', this._updateAuth);
+
+ this.updateComplete.then(()=> {
+ this.matomo = this.shadowRoot.querySelector(this.constructor.getScopedTagName('dbp-matomo'));
+ });
}
disconnectedCallback() {
@@ -638,6 +650,8 @@ export class AppShell extends ScopedElementsMixin(LitElement) {
}
}
+ this.track('renderActivity', activity.element);
+
const elm = document.createElement(activity.element);
this._onActivityAdded(elm);
this._lastElm = elm;
@@ -658,6 +672,12 @@ export class AppShell extends ScopedElementsMixin(LitElement) {
this._attrObserver.disconnect();
}
+ track(action, message) {
+ if (this.matomo !== null) {
+ this.matomo.track(action, message);
+ }
+ }
+
_renderActivity() {
const act = this.metadata[this.activeView];
if (act === undefined)
@@ -713,6 +733,7 @@ export class AppShell extends ScopedElementsMixin(LitElement) {
return html`
<slot class="${slotClassMap}"></slot>
<dbp-auth-keycloak lang="${this.lang}" url="${kc.url}" realm="${kc.realm}" client-id="${kc.clientId}" silent-check-sso-redirect-uri="${kc.silentCheckSsoRedirectUri || ''}" scope="${kc.scope || ''}" idp-hint="${kc.idpHint || ''}" load-person try-login></dbp-auth-keycloak>
+ <dbp-matomo endpoint="${this.matomoUrl}" site-id="${this.matomoSiteId}"></dbp-matomo>
<div class="${mainClassMap}">
<div id="main">
<dbp-notification lang="${this.lang}"></dbp-notification>
diff --git a/packages/matomo/.gitignore b/packages/matomo/.gitignore
new file mode 100644
index 0000000000000000000000000000000000000000..e62f92aa809c7345cb05914d7143b0322ab6d725
--- /dev/null
+++ b/packages/matomo/.gitignore
@@ -0,0 +1,5 @@
+dist
+node_modules
+.idea
+npm-debug.log
+package-lock.json
diff --git a/packages/matomo/.gitmodules b/packages/matomo/.gitmodules
new file mode 100644
index 0000000000000000000000000000000000000000..6ae19f67f21fde146a865f6f66411fc06ced3834
--- /dev/null
+++ b/packages/matomo/.gitmodules
@@ -0,0 +1,6 @@
+[submodule "vendor/auth"]
+ path = vendor/auth
+ url = git@gitlab.tugraz.at:dbp/web-components/Auth.git
+[submodule "vendor/common"]
+ path = vendor/common
+ url = git@gitlab.tugraz.at:dbp/web-components/Common.git
diff --git a/packages/matomo/LICENSE b/packages/matomo/LICENSE
new file mode 100644
index 0000000000000000000000000000000000000000..4362b49151d7b34ef83b3067a8f9c9f877d72a0e
--- /dev/null
+++ b/packages/matomo/LICENSE
@@ -0,0 +1,502 @@
+ GNU LESSER GENERAL PUBLIC LICENSE
+ Version 2.1, February 1999
+
+ Copyright (C) 1991, 1999 Free Software Foundation, Inc.
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+[This is the first released version of the Lesser GPL. It also counts
+ as the successor of the GNU Library Public License, version 2, hence
+ the version number 2.1.]
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+Licenses are intended to guarantee your freedom to share and change
+free software--to make sure the software is free for all its users.
+
+ This license, the Lesser General Public License, applies to some
+specially designated software packages--typically libraries--of the
+Free Software Foundation and other authors who decide to use it. You
+can use it too, but we suggest you first think carefully about whether
+this license or the ordinary General Public License is the better
+strategy to use in any particular case, based on the explanations below.
+
+ When we speak of free software, we are referring to freedom of use,
+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 this service if you wish); that you receive source code or can get
+it if you want it; that you can change the software and use pieces of
+it in new free programs; and that you are informed that you can do
+these things.
+
+ To protect your rights, we need to make restrictions that forbid
+distributors to deny you these rights or to ask you to surrender these
+rights. These restrictions translate to certain responsibilities for
+you if you distribute copies of the library or if you modify it.
+
+ For example, if you distribute copies of the library, whether gratis
+or for a fee, you must give the recipients all the rights that we gave
+you. You must make sure that they, too, receive or can get the source
+code. If you link other code with the library, you must provide
+complete object files to the recipients, so that they can relink them
+with the library after making changes to the library and recompiling
+it. And you must show them these terms so they know their rights.
+
+ We protect your rights with a two-step method: (1) we copyright the
+library, and (2) we offer you this license, which gives you legal
+permission to copy, distribute and/or modify the library.
+
+ To protect each distributor, we want to make it very clear that
+there is no warranty for the free library. Also, if the library is
+modified by someone else and passed on, the recipients should know
+that what they have is not the original version, so that the original
+author's reputation will not be affected by problems that might be
+introduced by others.
+
+ Finally, software patents pose a constant threat to the existence of
+any free program. We wish to make sure that a company cannot
+effectively restrict the users of a free program by obtaining a
+restrictive license from a patent holder. Therefore, we insist that
+any patent license obtained for a version of the library must be
+consistent with the full freedom of use specified in this license.
+
+ Most GNU software, including some libraries, is covered by the
+ordinary GNU General Public License. This license, the GNU Lesser
+General Public License, applies to certain designated libraries, and
+is quite different from the ordinary General Public License. We use
+this license for certain libraries in order to permit linking those
+libraries into non-free programs.
+
+ When a program is linked with a library, whether statically or using
+a shared library, the combination of the two is legally speaking a
+combined work, a derivative of the original library. The ordinary
+General Public License therefore permits such linking only if the
+entire combination fits its criteria of freedom. The Lesser General
+Public License permits more lax criteria for linking other code with
+the library.
+
+ We call this license the "Lesser" General Public License because it
+does Less to protect the user's freedom than the ordinary General
+Public License. It also provides other free software developers Less
+of an advantage over competing non-free programs. These disadvantages
+are the reason we use the ordinary General Public License for many
+libraries. However, the Lesser license provides advantages in certain
+special circumstances.
+
+ For example, on rare occasions, there may be a special need to
+encourage the widest possible use of a certain library, so that it becomes
+a de-facto standard. To achieve this, non-free programs must be
+allowed to use the library. A more frequent case is that a free
+library does the same job as widely used non-free libraries. In this
+case, there is little to gain by limiting the free library to free
+software only, so we use the Lesser General Public License.
+
+ In other cases, permission to use a particular library in non-free
+programs enables a greater number of people to use a large body of
+free software. For example, permission to use the GNU C Library in
+non-free programs enables many more people to use the whole GNU
+operating system, as well as its variant, the GNU/Linux operating
+system.
+
+ Although the Lesser General Public License is Less protective of the
+users' freedom, it does ensure that the user of a program that is
+linked with the Library has the freedom and the wherewithal to run
+that program using a modified version of the Library.
+
+ The precise terms and conditions for copying, distribution and
+modification follow. Pay close attention to the difference between a
+"work based on the library" and a "work that uses the library". The
+former contains code derived from the library, whereas the latter must
+be combined with the library in order to run.
+
+ GNU LESSER GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License Agreement applies to any software library or other
+program which contains a notice placed by the copyright holder or
+other authorized party saying it may be distributed under the terms of
+this Lesser General Public License (also called "this License").
+Each licensee is addressed as "you".
+
+ A "library" means a collection of software functions and/or data
+prepared so as to be conveniently linked with application programs
+(which use some of those functions and data) to form executables.
+
+ The "Library", below, refers to any such software library or work
+which has been distributed under these terms. A "work based on the
+Library" means either the Library or any derivative work under
+copyright law: that is to say, a work containing the Library or a
+portion of it, either verbatim or with modifications and/or translated
+straightforwardly into another language. (Hereinafter, translation is
+included without limitation in the term "modification".)
+
+ "Source code" for a work means the preferred form of the work for
+making modifications to it. For a library, complete source code means
+all the source code for all modules it contains, plus any associated
+interface definition files, plus the scripts used to control compilation
+and installation of the library.
+
+ Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running a program using the Library is not restricted, and output from
+such a program is covered only if its contents constitute a work based
+on the Library (independent of the use of the Library in a tool for
+writing it). Whether that is true depends on what the Library does
+and what the program that uses the Library does.
+
+ 1. You may copy and distribute verbatim copies of the Library's
+complete source code as you receive it, in any medium, provided that
+you conspicuously and appropriately publish on each copy an
+appropriate copyright notice and disclaimer of warranty; keep intact
+all the notices that refer to this License and to the absence of any
+warranty; and distribute a copy of this License along with the
+Library.
+
+ You may charge a fee for the physical act of transferring a copy,
+and you may at your option offer warranty protection in exchange for a
+fee.
+
+ 2. You may modify your copy or copies of the Library or any portion
+of it, thus forming a work based on the Library, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) The modified work must itself be a software library.
+
+ b) You must cause the files modified to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ c) You must cause the whole of the work to be licensed at no
+ charge to all third parties under the terms of this License.
+
+ d) If a facility in the modified Library refers to a function or a
+ table of data to be supplied by an application program that uses
+ the facility, other than as an argument passed when the facility
+ is invoked, then you must make a good faith effort to ensure that,
+ in the event an application does not supply such function or
+ table, the facility still operates, and performs whatever part of
+ its purpose remains meaningful.
+
+ (For example, a function in a library to compute square roots has
+ a purpose that is entirely well-defined independent of the
+ application. Therefore, Subsection 2d requires that any
+ application-supplied function or table used by this function must
+ be optional: if the application does not supply it, the square
+ root function must still compute square roots.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Library,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Library, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote
+it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Library.
+
+In addition, mere aggregation of another work not based on the Library
+with the Library (or with a work based on the Library) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may opt to apply the terms of the ordinary GNU General Public
+License instead of this License to a given copy of the Library. To do
+this, you must alter all the notices that refer to this License, so
+that they refer to the ordinary GNU General Public License, version 2,
+instead of to this License. (If a newer version than version 2 of the
+ordinary GNU General Public License has appeared, then you can specify
+that version instead if you wish.) Do not make any other change in
+these notices.
+
+ Once this change is made in a given copy, it is irreversible for
+that copy, so the ordinary GNU General Public License applies to all
+subsequent copies and derivative works made from that copy.
+
+ This option is useful when you wish to copy part of the code of
+the Library into a program that is not a library.
+
+ 4. You may copy and distribute the Library (or a portion or
+derivative of it, under Section 2) in object code or executable form
+under the terms of Sections 1 and 2 above provided that you accompany
+it with the complete corresponding machine-readable source code, which
+must be distributed under the terms of Sections 1 and 2 above on a
+medium customarily used for software interchange.
+
+ If distribution of object code is made by offering access to copy
+from a designated place, then offering equivalent access to copy the
+source code from the same place satisfies the requirement to
+distribute the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 5. A program that contains no derivative of any portion of the
+Library, but is designed to work with the Library by being compiled or
+linked with it, is called a "work that uses the Library". Such a
+work, in isolation, is not a derivative work of the Library, and
+therefore falls outside the scope of this License.
+
+ However, linking a "work that uses the Library" with the Library
+creates an executable that is a derivative of the Library (because it
+contains portions of the Library), rather than a "work that uses the
+library". The executable is therefore covered by this License.
+Section 6 states terms for distribution of such executables.
+
+ When a "work that uses the Library" uses material from a header file
+that is part of the Library, the object code for the work may be a
+derivative work of the Library even though the source code is not.
+Whether this is true is especially significant if the work can be
+linked without the Library, or if the work is itself a library. The
+threshold for this to be true is not precisely defined by law.
+
+ If such an object file uses only numerical parameters, data
+structure layouts and accessors, and small macros and small inline
+functions (ten lines or less in length), then the use of the object
+file is unrestricted, regardless of whether it is legally a derivative
+work. (Executables containing this object code plus portions of the
+Library will still fall under Section 6.)
+
+ Otherwise, if the work is a derivative of the Library, you may
+distribute the object code for the work under the terms of Section 6.
+Any executables containing that work also fall under Section 6,
+whether or not they are linked directly with the Library itself.
+
+ 6. As an exception to the Sections above, you may also combine or
+link a "work that uses the Library" with the Library to produce a
+work containing portions of the Library, and distribute that work
+under terms of your choice, provided that the terms permit
+modification of the work for the customer's own use and reverse
+engineering for debugging such modifications.
+
+ You must give prominent notice with each copy of the work that the
+Library is used in it and that the Library and its use are covered by
+this License. You must supply a copy of this License. If the work
+during execution displays copyright notices, you must include the
+copyright notice for the Library among them, as well as a reference
+directing the user to the copy of this License. Also, you must do one
+of these things:
+
+ a) Accompany the work with the complete corresponding
+ machine-readable source code for the Library including whatever
+ changes were used in the work (which must be distributed under
+ Sections 1 and 2 above); and, if the work is an executable linked
+ with the Library, with the complete machine-readable "work that
+ uses the Library", as object code and/or source code, so that the
+ user can modify the Library and then relink to produce a modified
+ executable containing the modified Library. (It is understood
+ that the user who changes the contents of definitions files in the
+ Library will not necessarily be able to recompile the application
+ to use the modified definitions.)
+
+ b) Use a suitable shared library mechanism for linking with the
+ Library. A suitable mechanism is one that (1) uses at run time a
+ copy of the library already present on the user's computer system,
+ rather than copying library functions into the executable, and (2)
+ will operate properly with a modified version of the library, if
+ the user installs one, as long as the modified version is
+ interface-compatible with the version that the work was made with.
+
+ c) Accompany the work with a written offer, valid for at
+ least three years, to give the same user the materials
+ specified in Subsection 6a, above, for a charge no more
+ than the cost of performing this distribution.
+
+ d) If distribution of the work is made by offering access to copy
+ from a designated place, offer equivalent access to copy the above
+ specified materials from the same place.
+
+ e) Verify that the user has already received a copy of these
+ materials or that you have already sent this user a copy.
+
+ For an executable, the required form of the "work that uses the
+Library" must include any data and utility programs needed for
+reproducing the executable from it. However, as a special exception,
+the materials to be distributed need not include anything that is
+normally distributed (in either source or binary form) with the major
+components (compiler, kernel, and so on) of the operating system on
+which the executable runs, unless that component itself accompanies
+the executable.
+
+ It may happen that this requirement contradicts the license
+restrictions of other proprietary libraries that do not normally
+accompany the operating system. Such a contradiction means you cannot
+use both them and the Library together in an executable that you
+distribute.
+
+ 7. You may place library facilities that are a work based on the
+Library side-by-side in a single library together with other library
+facilities not covered by this License, and distribute such a combined
+library, provided that the separate distribution of the work based on
+the Library and of the other library facilities is otherwise
+permitted, and provided that you do these two things:
+
+ a) Accompany the combined library with a copy of the same work
+ based on the Library, uncombined with any other library
+ facilities. This must be distributed under the terms of the
+ Sections above.
+
+ b) Give prominent notice with the combined library of the fact
+ that part of it is a work based on the Library, and explaining
+ where to find the accompanying uncombined form of the same work.
+
+ 8. You may not copy, modify, sublicense, link with, or distribute
+the Library except as expressly provided under this License. Any
+attempt otherwise to copy, modify, sublicense, link with, or
+distribute the Library is void, and will automatically terminate your
+rights under this License. However, parties who have received copies,
+or rights, from you under this License will not have their licenses
+terminated so long as such parties remain in full compliance.
+
+ 9. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Library or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Library (or any work based on the
+Library), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Library or works based on it.
+
+ 10. Each time you redistribute the Library (or any work based on the
+Library), the recipient automatically receives a license from the
+original licensor to copy, distribute, link with or modify the Library
+subject to these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties with
+this License.
+
+ 11. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+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
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Library at all. For example, if a patent
+license would not permit royalty-free redistribution of the Library by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Library.
+
+If any portion of this section is held invalid or unenforceable under any
+particular circumstance, the balance of the section is intended to apply,
+and the section as a whole is intended to apply in other circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 12. If the distribution and/or use of the Library is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Library under this License may add
+an explicit geographical distribution limitation excluding those countries,
+so that distribution is permitted only in or among countries not thus
+excluded. In such case, this License incorporates the limitation as if
+written in the body of this License.
+
+ 13. The Free Software Foundation may publish revised and/or new
+versions of the Lesser 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 Library
+specifies a version number of this License which applies to it and
+"any later version", you have the option of following the terms and
+conditions either of that version or of any later version published by
+the Free Software Foundation. If the Library does not specify a
+license version number, you may choose any version ever published by
+the Free Software Foundation.
+
+ 14. If you wish to incorporate parts of the Library into other free
+programs whose distribution conditions are incompatible with these,
+write to the author to ask for permission. For software which is
+copyrighted by the Free Software Foundation, write to the Free
+Software Foundation; we sometimes make exceptions for this. Our
+decision will be guided by the two goals of preserving the free status
+of all derivatives of our free software and of promoting the sharing
+and reuse of software generally.
+
+ NO WARRANTY
+
+ 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
+WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
+EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
+OTHER PARTIES PROVIDE THE LIBRARY "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
+LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
+THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
+WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
+AND/OR REDISTRIBUTE THE LIBRARY 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
+LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
+SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Libraries
+
+ If you develop a new library, and you want it to be of the greatest
+possible use to the public, we recommend making it free software that
+everyone can redistribute and change. You can do so by permitting
+redistribution under these terms (or, alternatively, under the terms of the
+ordinary General Public License).
+
+ To apply these terms, attach the following notices to the library. It is
+safest to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least the
+"copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the library's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Lesser General Public
+ License as published by the Free Software Foundation; either
+ version 2.1 of the License, or (at your option) any later version.
+
+ This library 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
+ Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public
+ License along with this library; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+Also add information on how to contact you by electronic and paper mail.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the library, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the
+ library `Frob' (a library for tweaking knobs) written by James Random Hacker.
+
+ <signature of Ty Coon>, 1 April 1990
+ Ty Coon, President of Vice
+
+That's all there is to it!
diff --git a/packages/matomo/README.md b/packages/matomo/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..7ecd7492f95ac040c2de9646d57703efe4cf2998
--- /dev/null
+++ b/packages/matomo/README.md
@@ -0,0 +1,55 @@
+# Matomo Web Component
+
+[GitLab Repository](git@gitlab.tugraz.at:dbp/web-components/toolkit.git)
+
+## Usage
+
+```html
+<dbp-matomo></dbp-matomo>
+```
+
+## Attributes
+
+- `endpoint` (required): set to your *Matomo* server
+ - example `<dbp-matomo endpoint="https://my-matomo.tld"></dbp-matomo>`
+- `site-id` (required): set to your site id
+ - example `<dbp-matomo site-id="456789"></dbp-matomo>`
+
+## Tracking actions
+
+```javascript
+class Demo {
+
+ track(action, message) {
+ const matomo = this.shadowRoot.querySelector(this.constructor.getScopedTagName('dbp-matomo'));
+ if (matomo !== null) {
+ matomo.track(action, message);
+ }
+ }
+
+ clickMe() {
+ this.track('button clicked', 'alert()');
+ }
+
+}
+```
+
+## Local development
+
+```bash
+# get the source
+git clone git@gitlab.tugraz.at:dbp/web-components/toolkit.git
+cd toolkit/packages/matomo
+git submodule update --init
+
+# install dependencies (make sure you have npm version 4+ installed, so symlinks to the git submodules are created automatically)
+yarn install
+
+# constantly build dist/bundle.js and run a local web-server on port 8002
+yarn run watch
+
+# run tests
+yarn test
+```
+
+Jump to <http://localhost:8002> and you should get a demo page.
diff --git a/packages/matomo/assets/favicon.ico b/packages/matomo/assets/favicon.ico
new file mode 100644
index 0000000000000000000000000000000000000000..f6cf22d1afc22f071d2b64c7779bc5214c3adae5
Binary files /dev/null and b/packages/matomo/assets/favicon.ico differ
diff --git a/packages/matomo/assets/index.html.ejs b/packages/matomo/assets/index.html.ejs
new file mode 100644
index 0000000000000000000000000000000000000000..580ad863f6e42c7fe3b5cfa433a9092e9e198a45
--- /dev/null
+++ b/packages/matomo/assets/index.html.ejs
@@ -0,0 +1,15 @@
+<!doctype html>
+<html>
+<head>
+ <meta charset="UTF-8">
+ <script type="module" src="dbp-matomo-demo.js"></script>
+</head>
+
+<body>
+
+<dbp-matomo-demo lang="de" matomo-url="<%= matomoUrl %>" matomo-site-id="<%= matomoSiteId %>"></dbp-matomo-demo>
+
+<p>version: <span style="color: white; background-color: black;"><%= buildInfo.info %></span></p>
+<p>Matomo: url: <%= matomoUrl %>, site-id: <%= matomoSiteId %></p>
+</body>
+</html>
diff --git a/packages/matomo/i18next-scanner.config.js b/packages/matomo/i18next-scanner.config.js
new file mode 100644
index 0000000000000000000000000000000000000000..8c277798414be902846c6eb4f0e95a19750cda39
--- /dev/null
+++ b/packages/matomo/i18next-scanner.config.js
@@ -0,0 +1,15 @@
+module.exports = {
+ input: [
+ 'src/*.js',
+ ],
+ output: './',
+ options: {
+ debug: false,
+ removeUnusedKeys: true,
+ lngs: ['en','de'],
+ resource: {
+ loadPath: 'src/i18n/{{lng}}/{{ns}}.json',
+ savePath: 'src/i18n/{{lng}}/{{ns}}.json'
+ },
+ },
+}
diff --git a/packages/matomo/karma.conf.js b/packages/matomo/karma.conf.js
new file mode 100644
index 0000000000000000000000000000000000000000..6a646f5ec9ea5a6c50dd25dc6038dd94fff1bc43
--- /dev/null
+++ b/packages/matomo/karma.conf.js
@@ -0,0 +1,23 @@
+// Trick to use the auto-downloaded puppeteer chrome binary
+process.env.CHROME_BIN = require('puppeteer').executablePath();
+
+module.exports = function(config) {
+ config.set({
+ basePath: 'dist',
+ frameworks: ['mocha', 'chai'],
+ files: [
+ {pattern: './*.js', included: true, watched: true, served: true, type: 'module'},
+ {pattern: './**/*', included: false, watched: true, served: true},
+ ],
+ autoWatch: true,
+ browsers: ['ChromeHeadlessNoSandbox'],
+ customLaunchers: {
+ ChromeHeadlessNoSandbox: {
+ base: 'ChromeHeadless',
+ flags: ['--no-sandbox']
+ }
+ },
+ singleRun: false,
+ logLevel: config.LOG_ERROR
+ });
+}
diff --git a/packages/matomo/package.json b/packages/matomo/package.json
new file mode 100644
index 0000000000000000000000000000000000000000..7dcdfa0a923d6e7d9a30cb6552eaddf42b43c9cc
--- /dev/null
+++ b/packages/matomo/package.json
@@ -0,0 +1,46 @@
+{
+ "name": "dbp-matomo",
+ "version": "1.0.0",
+ "main": "src/index.js",
+ "license": "LGPL-2.1-or-later",
+ "private": true,
+ "devDependencies": {
+ "@rollup/plugin-commonjs": "^14.0.0",
+ "@rollup/plugin-json": "^4.1.0",
+ "@rollup/plugin-node-resolve": "^8.1.0",
+ "@rollup/plugin-url": "^5.0.1",
+ "chai": "^4.2.0",
+ "i18next-scanner": "^2.10.2",
+ "karma": "^5.1.0",
+ "karma-chai": "^0.1.0",
+ "karma-chrome-launcher": "^3.0.0",
+ "karma-mocha": "^2.0.1",
+ "mocha": "^8.0.1",
+ "puppeteer": "^2.1.1",
+ "rollup": "^2.19.0",
+ "rollup-plugin-consts": "^1.0.1",
+ "rollup-plugin-copy": "^3.1.0",
+ "rollup-plugin-delete": "^2.0.0",
+ "rollup-plugin-serve": "^1.0.1",
+ "rollup-plugin-terser": "^6.1.0"
+ },
+ "dependencies": {
+ "@open-wc/scoped-elements": "^1.1.1",
+ "lit-element": "^2.3.1",
+ "dbp-auth": "^1.0.0",
+ "dbp-common": "^1.0.0"
+ },
+ "scripts": {
+ "clean": "rm dist/*",
+ "build-local": "rollup -c",
+ "build-dev": "rollup -c --environment BUILD:development",
+ "build-prod": "rollup -c --environment BUILD:production",
+ "build-demo": "rollup -c --environment BUILD:demo",
+ "build-test": "rollup -c --environment BUILD:test",
+ "i18next": "i18next-scanner",
+ "watch": "rollup -c --watch",
+ "watch-local": "yarn run watch",
+ "watch-dev": "rollup -c --watch --environment BUILD:development",
+ "test": "rollup -c --environment BUILD:test && karma start --singleRun"
+ }
+}
diff --git a/packages/matomo/rollup.config.js b/packages/matomo/rollup.config.js
new file mode 100644
index 0000000000000000000000000000000000000000..6c05efb3a6fcc72775b2047f359baaff1e985a3c
--- /dev/null
+++ b/packages/matomo/rollup.config.js
@@ -0,0 +1,108 @@
+import glob from 'glob';
+import resolve from '@rollup/plugin-node-resolve';
+import commonjs from '@rollup/plugin-commonjs';
+import copy from 'rollup-plugin-copy';
+import {terser} from "rollup-plugin-terser";
+import json from '@rollup/plugin-json';
+import serve from 'rollup-plugin-serve';
+import url from "@rollup/plugin-url";
+import consts from 'rollup-plugin-consts';
+import del from 'rollup-plugin-delete';
+import emitEJS from 'rollup-plugin-emit-ejs'
+import {getPackagePath} from '../../rollup.utils.js';
+
+const pkg = require('./package.json');
+const build = (typeof process.env.BUILD !== 'undefined') ? process.env.BUILD : 'local';
+console.log("build: " + build);
+const matomoUrl = "https://analytics.tugraz.at/";
+const matomoSiteId = 131;
+
+function getBuildInfo() {
+ const child_process = require('child_process');
+ const url = require('url');
+
+ let remote = child_process.execSync('git config --get remote.origin.url').toString().trim();
+ let commit = child_process.execSync('git rev-parse --short HEAD').toString().trim();
+
+ let parsed = url.parse(remote);
+ // convert git urls
+ if (parsed.protocol === null) {
+ parsed = url.parse('git://' + remote.replace(":", "/"));
+ parsed.protocol = 'https:';
+ }
+ let newPath = parsed.path.slice(0, parsed.path.lastIndexOf('.'));
+ let newUrl = parsed.protocol + '//' + parsed.host + newPath + '/commit/' + commit;
+
+ return {
+ info: commit,
+ url: newUrl,
+ time: new Date().toISOString(),
+ env: build
+ }
+}
+
+export default (async () => {
+ return {
+ input: (build != 'test') ? ['src/dbp-matomo.js', 'src/dbp-matomo-demo.js'] : glob.sync('test/**/*.js'),
+ output: {
+ dir: 'dist',
+ entryFileNames: '[name].js',
+ chunkFileNames: 'shared/[name].[hash].[format].js',
+ format: 'esm',
+ sourcemap: true
+ },
+ onwarn: function (warning, warn) {
+ // keycloak bundled code uses eval
+ if (warning.code === 'EVAL') {
+ return;
+ }
+ warn(warning);
+ },
+ plugins: [
+ del({
+ targets: 'dist/*'
+ }),
+ consts({
+ environment: build,
+ buildInfo: getBuildInfo(),
+ }),
+ emitEJS({
+ src: 'assets',
+ include: ['**/*.ejs', '**/.*.ejs'],
+ data: {
+ getUrl: (p) => {
+ return url.resolve(basePath, p);
+ },
+ getPrivateUrl: (p) => {
+ return url.resolve(`${basePath}local/${pkg.name}/`, p);
+ },
+ name: pkg.name,
+ environment: build,
+ matomoUrl: matomoUrl,
+ matomoSiteId: matomoSiteId,
+ buildInfo: getBuildInfo()
+ }
+ }),
+ resolve(),
+ commonjs(),
+ url({
+ limit: 0,
+ include: [
+ await getPackagePath('select2', '**/*.css'),
+ ],
+ emitFiles: true,
+ fileName: 'shared/[name].[hash][extname]'
+ }),
+ json(),
+ (build !== 'local' && build !== 'test') ? terser() : false,
+ copy({
+ targets: [
+ {src: 'assets/index.html', dest: 'dist'},
+ {src: await getPackagePath('dbp-common', 'assets/icons/*.svg'), dest: 'dist/local/dbp-common/icons'},
+ {src: 'assets/favicon.ico', dest:'dist'},
+ ],
+ }),
+ (process.env.ROLLUP_WATCH === 'true') ? serve({contentBase: 'dist', host: '127.0.0.1', port: 8002}) : false
+ ]
+ };
+})();
\ No newline at end of file
diff --git a/packages/matomo/src/dbp-matomo-demo.js b/packages/matomo/src/dbp-matomo-demo.js
new file mode 100644
index 0000000000000000000000000000000000000000..3437bc1763ae4242fa3cab972c0d8f09ce2e5023
--- /dev/null
+++ b/packages/matomo/src/dbp-matomo-demo.js
@@ -0,0 +1,85 @@
+import {i18n} from './i18n.js';
+import {css, html, LitElement} from 'lit-element';
+import {ScopedElementsMixin} from '@open-wc/scoped-elements';
+import {AuthKeycloak, LoginButton} from 'dbp-auth';
+import * as commonUtils from 'dbp-common/utils';
+import * as commonStyles from 'dbp-common/styles';
+import {MatomoElement} from './matomo';
+
+
+class MatomoDemo extends ScopedElementsMixin(LitElement) {
+
+ constructor() {
+ super();
+ this.lang = 'de';
+ this.matomoUrl = '';
+ this.matomoSiteId = -1;
+ }
+
+ static get scopedElements() {
+ return {
+ 'dbp-auth-keycloak': AuthKeycloak,
+ 'dbp-login-button': LoginButton,
+ 'dbp-matomo': MatomoElement,
+ };
+ }
+
+ static get properties() {
+ return {
+ lang: { type: String },
+ matomoUrl: { type: String, attribute: "matomo-url" },
+ matomoSiteId: { type: Number, attribute: "matomo-site-id" },
+ };
+ }
+
+ connectedCallback() {
+ super.connectedCallback();
+ i18n.changeLanguage(this.lang);
+ }
+
+ track(action, message) {
+ const matomo = this.shadowRoot.querySelector(this.constructor.getScopedTagName('dbp-matomo'));
+ if (matomo !== null) {
+ matomo.track(action, message);
+ }
+ }
+
+ clickMe() {
+ this.track('button clicked', 'alert()');
+
+ alert('button clicked!');
+ }
+
+ static get styles() {
+ // language=css
+ return [
+ commonStyles.getThemeCSS(),
+ commonStyles.getGeneralCSS(),
+ css`
+ h1.title {margin-bottom: 1em;}
+ div.container {margin-bottom: 1.5em; padding-left:20px;}
+ `
+ ];
+ }
+
+ render() {
+ return html`
+ <section class="section">
+ <div class="container">
+ <h1 class="title">Matomo-Demo</h1>
+ </div>
+ <div class="container">
+ <dbp-auth-keycloak lang="${this.lang}" url="https://auth-dev.tugraz.at/auth" realm="tugraz" client-id="auth-dev-mw-frontend-local" load-person try-login></dbp-auth-keycloak>
+ <dbp-login-button lang="${this.lang}" show-image></dbp-login-button>
+ <dbp-matomo endpoint="${this.matomoUrl}" site-id="${this.matomoSiteId}"></dbp-matomo>
+ </div>
+ <div class="container">
+ <p>Click this button (and watch the network traffic) ...</p>
+ <p><input type="button" value="click me" @click="${this.clickMe}"></p>
+ </div>
+ </section>
+ `;
+ }
+}
+
+commonUtils.defineCustomElement('dbp-matomo-demo', MatomoDemo);
diff --git a/packages/matomo/src/dbp-matomo.js b/packages/matomo/src/dbp-matomo.js
new file mode 100644
index 0000000000000000000000000000000000000000..34ca672c34b97eec310d72772d639313e2a28026
--- /dev/null
+++ b/packages/matomo/src/dbp-matomo.js
@@ -0,0 +1,4 @@
+import * as commonUtils from 'dbp-common/utils';
+import {MatomoElement} from './matomo.js';
+
+commonUtils.defineCustomElement('dbp-matomo', MatomoElement);
diff --git a/packages/matomo/src/demo.js b/packages/matomo/src/demo.js
new file mode 100644
index 0000000000000000000000000000000000000000..08dfd041306a9c2f8ed1427b01e2aa0a425b16ae
--- /dev/null
+++ b/packages/matomo/src/demo.js
@@ -0,0 +1 @@
+import './dbp-matomo-demo.js';
\ No newline at end of file
diff --git a/packages/matomo/src/i18n.js b/packages/matomo/src/i18n.js
new file mode 100644
index 0000000000000000000000000000000000000000..3fb3a1afd97f502121cf5f938fa17ae4ae5bcbef
--- /dev/null
+++ b/packages/matomo/src/i18n.js
@@ -0,0 +1,6 @@
+import {createInstance} from 'dbp-common/i18next.js';
+
+import de from './i18n/de/translation.json';
+import en from './i18n/en/translation.json';
+
+export const i18n = createInstance({en: en, de: de}, 'de', 'en');
\ No newline at end of file
diff --git a/packages/matomo/src/i18n/de/translation.json b/packages/matomo/src/i18n/de/translation.json
new file mode 100644
index 0000000000000000000000000000000000000000..87a8a87f09208414abfad579bfa3611cbcddc57b
--- /dev/null
+++ b/packages/matomo/src/i18n/de/translation.json
@@ -0,0 +1,5 @@
+{
+ "matomo": {
+
+ }
+}
\ No newline at end of file
diff --git a/packages/matomo/src/i18n/en/translation.json b/packages/matomo/src/i18n/en/translation.json
new file mode 100644
index 0000000000000000000000000000000000000000..87a8a87f09208414abfad579bfa3611cbcddc57b
--- /dev/null
+++ b/packages/matomo/src/i18n/en/translation.json
@@ -0,0 +1,5 @@
+{
+ "matomo": {
+
+ }
+}
\ No newline at end of file
diff --git a/packages/matomo/src/index.js b/packages/matomo/src/index.js
new file mode 100644
index 0000000000000000000000000000000000000000..fca225961b2d2d8fd8a91b463f5d57fe8912752a
--- /dev/null
+++ b/packages/matomo/src/index.js
@@ -0,0 +1,3 @@
+import {Matomo} from './matomo.js';
+
+export {Matomo};
\ No newline at end of file
diff --git a/packages/matomo/src/matomo.js b/packages/matomo/src/matomo.js
new file mode 100644
index 0000000000000000000000000000000000000000..67f66d051e997a546f9cd10d8253985e422a75a6
--- /dev/null
+++ b/packages/matomo/src/matomo.js
@@ -0,0 +1,119 @@
+import {i18n} from './i18n.js';
+import {LitElement} from "lit-element";
+import DBPLitElement from 'dbp-common/dbp-lit-element';
+import {EventBus} from 'dbp-common';
+import buildInfo from 'consts:buildInfo';
+
+
+export class MatomoElement extends DBPLitElement {
+
+ constructor() {
+ super();
+ this.endpoint = '';
+ this.siteId = -1;
+ this.isRunning = false;
+ this.lastEvent = [];
+ }
+
+
+ static get properties() {
+ return {
+ endpoint: { type: String },
+ siteId: { type: Number, attribute: 'site-id' },
+ };
+ }
+
+ connectedCallback() {
+ super.connectedCallback();
+
+ this._bus = new EventBus();
+ this._bus.subscribe('auth-update', (data) => {
+ this.setupMatomo(data.status === 'logged-in');
+ });
+ }
+
+ disconnectedCallback() {
+ this._bus.close();
+ super.disconnectedCallback();
+ }
+
+ render() {
+ return ``;
+ }
+
+ setupMatomo(loggedIn) {
+ if (loggedIn && ! this.isRunning) {
+ if (this.siteId === -1) {
+ console.log('site id missing, skipping matomo...');
+ return;
+ }
+ if (this.endpoint === '') {
+ console.log('endpoint missing, skipping matomo...');
+ return;
+ }
+ console.log('add matomo...');
+
+ window._paq = window._paq || [];
+ _paq.push(['setCustomVariable', 1, "GitCommit", buildInfo.info, "visit"]);
+ _paq.push(['enableHeartBeatTimer']);
+ _paq.push(['disableCookies']);
+ _paq.push(['trackPageView']);
+ _paq.push(['enableLinkTracking']);
+
+ (function (endpoint, siteId) {
+ _paq.push(['setTrackerUrl', endpoint+'matomo.php']);
+ _paq.push(['setSiteId', siteId]);
+
+ var g = document.createElement('script');
+ var s = document.getElementsByTagName('script')[0];
+ g.type = 'text/javascript';
+ g.async = true;
+ g.defer = true;
+ g.src = endpoint + 'matomo.js';
+ s.parentNode.insertBefore(g, s);
+ })(this.endpoint, this.siteId);
+
+ // track changed locations
+ window.addEventListener('locationchanged', function(e) {
+ _paq.push(['setReferrerUrl', e.detail.referrerUrl]);
+ _paq.push(['setCustomUrl', location.href]);
+ // _paq.push(['setDocumentTitle', '']);
+ _paq.push(['trackPageView']);
+
+ // make Matomo aware of newly added content
+ var content = document.getElementById('content');
+ _paq.push(['MediaAnalytics::scanForMedia', content]);
+ _paq.push(['FormAnalytics::scanForForms', content]);
+ _paq.push(['trackContentImpressionsWithinNode', content]);
+ });
+
+ // track errors
+ window.addEventListener('error', function(e) {
+ _paq.push(['trackEvent', 'Error', e.error.message + '\n' + e.error.stack]);
+ });
+
+ this.isRunning = true;
+ if (this.lastEvent.length > 0) {
+ console.log('MatomoElement* (' + this.isRunning + '): ' + this.lastEvent[1] + ', ' + this.lastEvent[2]);
+ _paq.push(this.lastEvent);
+ this.lastEvent = [];
+ }
+ return;
+ }
+ if (! loggedIn && this.isRunning) {
+ // TODO: reomve those event listeners
+ console.log('remove matomo...');
+ this.isRunning = false;
+ }
+ }
+
+ track (action, message) {
+ console.log('MatomoElement (' + this.isRunning + '): ' + action + ', ' + message);
+ const event = ['trackEvent', action, message];
+ if (this.isRunning) {
+ _paq.push(event);
+ } else {
+ this.lastEvent = event;
+ }
+ }
+}
diff --git a/packages/matomo/test/unit.js b/packages/matomo/test/unit.js
new file mode 100644
index 0000000000000000000000000000000000000000..bc2f3f5d70c605f2f1bbaf305b7e4fe891bb8140
--- /dev/null
+++ b/packages/matomo/test/unit.js
@@ -0,0 +1,3 @@
+describe('dbp-matomo', () => {
+ it('should render', () => {});
+});
diff --git a/yarn.lock b/yarn.lock
index 0e6c9b658cf11fc8b622b20c5e0d7ee0bf89cc96..7c6189aeaf5d68dd20fc53ec31c48d3912f3a00c 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -1131,6 +1131,11 @@
resolved "https://registry.yarnpkg.com/@types/color-name/-/color-name-1.1.1.tgz#1c1261bbeaa10a8055bbc5d8ab84b7b2afc846a0"
integrity sha512-rr+OQyAjxze7GgWrSaJwydHStIhHq2lvY3BOC2Mj7KnzI7XK0Uw1TOOdI9lDoajEbSWLiYgoo4f1R51erQfhPQ==
+"@types/ejs@^3.0.4":
+ version "3.0.4"
+ resolved "https://registry.yarnpkg.com/@types/ejs/-/ejs-3.0.4.tgz#8851fcdedb96e410fbb24f83b8be6763ef9afa77"
+ integrity sha512-ZxnwyBGO4KX/82AsFHTX82eMw0PsoBcIngEat+zx0y+3yxoNDJucAihg9nAcrc+g4Cwiv/4WcWsX4oiy0ySrRQ==
+
"@types/estree@*":
version "0.0.45"
resolved "https://registry.yarnpkg.com/@types/estree/-/estree-0.0.45.tgz#e9387572998e5ecdac221950dab3e8c3b16af884"
@@ -1577,6 +1582,11 @@ async-limiter@~1.0.0:
resolved "https://registry.yarnpkg.com/async-limiter/-/async-limiter-1.0.1.tgz#dd379e94f0db8310b08291f9d64c3209766617fd"
integrity sha512-csOlWGAcRFJaI6m+F2WKdnMKr4HhdhFVBk0H/QbJFMCr+uO2kwohwXQPxw/9OCxp05r5ghVBFSyioixx3gfkNQ==
+async@0.9.x:
+ version "0.9.2"
+ resolved "https://registry.yarnpkg.com/async/-/async-0.9.2.tgz#aea74d5e61c1f899613bf64bda66d4c78f2fd17d"
+ integrity sha1-rqdNXmHB+JlhO/ZL2mbUx48v0X0=
+
asynckit@^0.4.0:
version "0.4.0"
resolved "https://registry.yarnpkg.com/asynckit/-/asynckit-0.4.0.tgz#c79ed97f7f34cb8f2ba1bc9790bcc366474b4b79"
@@ -2996,6 +3006,13 @@ ee-first@1.1.1:
resolved "https://registry.yarnpkg.com/ee-first/-/ee-first-1.1.1.tgz#590c61156b0ae2f4f0255732a158b266bc56b21d"
integrity sha1-WQxhFWsK4vTwJVcyoViyZrxWsh0=
+ejs@^3.1.3:
+ version "3.1.5"
+ resolved "https://registry.yarnpkg.com/ejs/-/ejs-3.1.5.tgz#aed723844dc20acb4b170cd9ab1017e476a0d93b"
+ integrity sha512-dldq3ZfFtgVTJMLjOe+/3sROTzALlL9E34V4/sDtUd/KlBSS0s6U1/+WPE1B4sj9CXHJpL1M6rhNJnc9Wbal9w==
+ dependencies:
+ jake "^10.6.1"
+
electron-to-chromium@^1.3.488:
version "1.3.498"
resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.3.498.tgz#fd7188c8a49d6d0b5df1df55a1f1a4bf2c177457"
@@ -3449,7 +3466,7 @@ fast-glob@^2.2.6:
merge2 "^1.2.3"
micromatch "^3.1.10"
-fast-glob@^3.0.3:
+fast-glob@^3.0.3, fast-glob@^3.2.2:
version "3.2.4"
resolved "https://registry.yarnpkg.com/fast-glob/-/fast-glob-3.2.4.tgz#d20aefbf99579383e7f3cc66529158c9b98554d3"
integrity sha512-kr/Oo6PX51265qeuCYsyGypiO5uJFgBS0jksyG7FUeCyQzNwYnzrNIMR1NXfkZXsMYXYLRAHgISHBz8gQcxKHQ==
@@ -3519,6 +3536,13 @@ file-saver@^2.0.2:
resolved "https://registry.yarnpkg.com/file-saver/-/file-saver-2.0.2.tgz#06d6e728a9ea2df2cce2f8d9e84dfcdc338ec17a"
integrity sha512-Wz3c3XQ5xroCxd1G8b7yL0Ehkf0TC9oYC6buPFkNnU9EnaPlifeAFCyCh+iewXTyFRcg0a6j3J7FmJsIhlhBdw==
+filelist@^1.0.1:
+ version "1.0.1"
+ resolved "https://registry.yarnpkg.com/filelist/-/filelist-1.0.1.tgz#f10d1a3ae86c1694808e8f20906f43d4c9132dbb"
+ integrity sha512-8zSK6Nu0DQIC08mUC46sWGXi+q3GGpKydAG36k+JDba6VRpkevvOWUW5a/PhShij4+vHT9M+ghgG7eM+a9JDUQ==
+ dependencies:
+ minimatch "^3.0.4"
+
fill-range@^4.0.0:
version "4.0.0"
resolved "https://registry.yarnpkg.com/fill-range/-/fill-range-4.0.0.tgz#d544811d428f98eb06a63dc402d2403c328c38f7"
@@ -4798,6 +4822,16 @@ iterate-value@^1.0.0:
es-get-iterator "^1.0.2"
iterate-iterator "^1.0.1"
+jake@^10.6.1:
+ version "10.8.2"
+ resolved "https://registry.yarnpkg.com/jake/-/jake-10.8.2.tgz#ebc9de8558160a66d82d0eadc6a2e58fbc500a7b"
+ integrity sha512-eLpKyrfG3mzvGE2Du8VoPbeSkRry093+tyNjdYaBbJS9v17knImYGNXQCUV0gLxQtF82m3E8iRb/wdSQZLoq7A==
+ dependencies:
+ async "0.9.x"
+ chalk "^2.4.2"
+ filelist "^1.0.1"
+ minimatch "^3.0.4"
+
jest-worker@^26.0.0:
version "26.1.0"
resolved "https://registry.yarnpkg.com/jest-worker/-/jest-worker-26.1.0.tgz#65d5641af74e08ccd561c240e7db61284f82f33d"
@@ -7283,6 +7317,16 @@ rollup-plugin-delete@^2.0.0:
dependencies:
del "^5.1.0"
+rollup-plugin-emit-ejs@^3.1.0:
+ version "3.1.0"
+ resolved "https://registry.yarnpkg.com/rollup-plugin-emit-ejs/-/rollup-plugin-emit-ejs-3.1.0.tgz#abf8804db49368517dcc0e8531e7e811c5d8dc11"
+ integrity sha512-GZR68O+tubvVH23KIn4487exrev1ojioH+QnD+VfqJE/Yczsq79yiLO8jp4eg3SulSbXerofz/7DnLfowMLdDg==
+ dependencies:
+ "@types/ejs" "^3.0.4"
+ ejs "^3.1.3"
+ fast-glob "^3.2.2"
+ fs-extra "^8.1.0"
+
rollup-plugin-postcss@^3.1.2:
version "3.1.3"
resolved "https://registry.yarnpkg.com/rollup-plugin-postcss/-/rollup-plugin-postcss-3.1.3.tgz#b11f69a907cc497311f44da12030439545a7bd80"