Piwigo.org

Blaufotograph · 2015-09-05 22:03:02

Hello @All,

im trying to get a little bit special to work with the piwigo StatisticsPlugin.

I would like to call a small php function from within the piwik javascript code. Could you help me please? I've used the google search for a general help and also for the special callings from a php-function from the javascript code.
Here is an example:

Code:

<!-- Plugin Statistics -->
<!-- Piwik -->
<script type="text/javascript">
  var _paq = _paq || [];
  // you can set up to 5 custom variables for each visitor

  _paq.push(["setCustomVariable", 1, "UserID", "<?php $_SERVER['REMOTE_USER']; >?", "visit"]);

  _paq.push(['trackPageView']);
  _paq.push(['enableLinkTracking']);
  (function() {
    var u="//piwik.domain.de/";
    _paq.push(['setTrackerUrl', u+'piwik.php']);
    _paq.push(['setSiteId', 1]);
    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+'piwik.js'; s.parentNode.insertBefore(g,s);
  })();
</script>
<noscript><p><img src="//piwik.domain.de/piwik.php?idsite=nn" style="border:0;" alt="" /></p></noscript>
<!-- End Piwik Code -->

<!-- Plugin Statistics -->

Could you give me please a little advise, how i could call the following part of php Script from within the Javascript code:

_paq.push(["setCustomVariable", 1, "UserID", "<?php $_SERVER['REMOTE_USER']; >?", "visit"]);

Of couse i also studied the Page http://developer.piwik.org/guides/track … variables, but the recommendation from there isn't working within the statistics plugin!

_paq.push(['setDocumentTitle', "<?php echo $myPageTitle ?>"]);

Piwigo version: newest version (i don't see it in the Piwigo GUI)
PHP version: 5.4.44-0+deb7u1
MySQL version: 5.5.44-0+deb7u1
Piwigo URL: http://

Last edited by Blaufotograph (2015-09-05 22:08:47)

Blaufotograph · 2015-09-25 21:38:18

Hello @All,

does maybe anyone have an idea? Is Piwigo filtering this kind of script calls ?

Thanks,

Axel Birndt

mistic100 · 2015-09-25 23:16:46

Hello

PHP code is not allowed in the Statistics plugin. Only JavaScript.

Here is what I propose :

I don't exactly know what is "REMOTE_USER", so I'll show you how to use the Piwigo user id instead, you can easily change the data you want (see the code comments)

1. create a personal plugin
to expose the user id somewhere in the page

Go to Plugins->LocalFiles Editor->Personal plugin and enter this

Code:

<?php
/*
Plugin Name: add hidden USER_ID
*/

add_event_handler('loc_end_page_header', 'add_user_id');
 
function add_user_id()
{
  global $template, $user;
  $template->assign('MY_USER_ID', $user['id']); // HERE you can replace $user['id'] by something else
  $template->set_prefilter('header', 'add_user_id_prefilter', 100);
}
 
function add_user_id_prefilter($content)
{
  return $content . "\n" . '<span style="display:none" id="my_user_id">{$MY_USER_ID}</span>';
}

Then activate the plugin in the Plugins management page.

2. In the Statistics input

Replace

Code:

"<?php $_SERVER['REMOTE_USER']; >?"

by

Code:

document.getElementById('my_user_id').innerHTML

You can enhance the personal plugin with more data ($template->assign + template declaration) and use them in Statistics with document.getElementById(...).innerHTML

plg · 2015-09-26 08:28:09

Interesting! Maybe a start to a better integration with Piwik :-)

Blaufotograph · 2015-09-27 18:09:35

mistic100 wrote:
Hello

PHP code is not allowed in the Statistics plugin. Only JavaScript.

Here is what I propose :

I don't exactly know what is "REMOTE_USER", so I'll show you how to use the Piwigo user id instead, you can easily change the data you want (see the code comments)

1. create a personal plugin
to expose the user id somewhere in the page

Go to Plugins->LocalFiles Editor->Personal plugin and enter this

Replace
Code:
"<?php $_SERVER['REMOTE_USER']; >?"
by

Hello Mistic100,

thank you very much for your hint. The 'REMOTE_USER' is the user which has logged in by basic authentication from the webserver (in my case from a Apache Web-Server).

I would like to log the user wich has logged in by Basic Authentication to the Apache.

After creating the the plugin i will put this here into this thread.

I hope i got it running.

regards, Axel

Blaufotograph · 2015-09-29 22:28:04

Hello Mistic100,

Of course the private plugin was created and succesful written.

unfortunately does the code not working.

I've created the the JavascriptCode as shown below:

Is there maybe an error in my generated Javascript:

Code:

<!-- Piwik -->
<script type="text/javascript">
  var _paq = _paq || [];
  // you can set up to 5 custom variables for each visitor

  _paq.push(["setCustomVariable", 1, "UserID", "document.getElementById('my_user_id').innerHTML", "visit"]);
  _paq.push(['trackPageView']);
  _paq.push(['enableLinkTracking']);
  (function() {
    var u="//piwik.domain.de/";
    _paq.push(['setTrackerUrl', u+'piwik.php']);
    _paq.push(['setSiteId', 1]);
    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+'piwik.js'; s.parentNode.insertBefore(g,s);
  })();
</script>
<noscript><p><img src="//piwik.domain.de/piwik.php?idsite=1" style="border:0;" alt="" /></p></noscript>
<!-- End Piwik Code -->

The generated Javascript code is:

Code:

<!-- Plugin Statistics -->
<!-- Piwik -->
<script type="text/javascript">
  var _paq = _paq || [];
  // you can set up to 5 custom variables for each visitor

  _paq.push(["setCustomVariable", 1, "UserID", "document.getElementById('my_user_id').innerHTML", "visit"]);
  _paq.push(['trackPageView']);
  _paq.push(['enableLinkTracking']);
  (function() {
    var u="//piwik.domain.de/";
    _paq.push(['setTrackerUrl', u+'piwik.php']);
    _paq.push(['setSiteId', 1]);
    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+'piwik.js'; s.parentNode.insertBefore(g,s);
  })();
</script>
<noscript><p><img src="//piwik.domain.de/piwik.php?idsite=1" style="border:0;" alt="" /></p></noscript>
<!-- End Piwik Code -->

<!-- Plugin Statistics -->

Now the Javascript Code "document.getElementById('my_user_id').innerHTML" wont be executed and the user-id was not replaced.

I would like to ask you again for a hint.
Thank you very much,
Kind regards Axel

Last edited by Blaufotograph (2015-09-29 22:32:02)

mistic100 · 2015-09-29 22:43:33

remove the quotes arround "document.getElementById('my_user_id').innerHTML"

I said

Replace note the quotes, to be removed

Code:

"<?php $_SERVER['REMOTE_USER']; >?"

by

Code:

document.getElementById('my_user_id').innerHTML

it was not a typo

Blaufotograph · 2015-09-30 22:16:39

mistic100 wrote:
remove the quotes [...]
Code:
document.getElementById('my_user_id').innerHTML
it was not a typo

Yesterday i haven't activated the personal plugin. I've done this now. But the code wont be executed and the variables wasnt replaced.

This is the Javascript Code from the Statistics Plugin:

Code:

<!-- Piwik -->
<script type="text/javascript">
  var _paq = _paq || [];
  // you can set up to 5 custom variables for each visitor

  _paq.push(["setCustomVariable", 1, "UserID", document.getElementById('my_user_id').innerHTML, "visit"]);
  _paq.push(['trackPageView']);
  _paq.push(['enableLinkTracking']);
  (function() {
    var u="//piwik.domain.de/";
    _paq.push(['setTrackerUrl', u+'piwik.php']);
    _paq.push(['setSiteId', 1]);
    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+'piwik.js'; s.parentNode.insertBefore(g,s);
  })();
</script>
<noscript><p><img src="//piwik.domain.de/piwik.php?idsite=1" style="border:0;" alt="" /></p></noscript>
<!-- End Piwik Code -->

By the way, i couldnt write the real url for the Piwigo Gallery here, because it is a private gallery. currently it is to much work to clone and clean the gallery for public access. I hope you could understand this.

mistic100 · 2015-09-30 22:21:49

If you actually have

Code:

<span style="display:none" id="my_user_id">something</span>

in the page, there is no reason it does not work

(you won't see the variable being actually replaced in the page, you must check it on Piwik side)

Blaufotograph · 2015-10-01 07:34:52

mistic100 wrote:
If you actually have
Code:
<span style="display:none" id="my_user_id">something</span>
in the page, there is no reason it does not work

(you won't see the variable being actually replaced in the page, you must check it on Piwik side)

Hello mistic100,

In my mind the code within the Javascript for the piwik Trackingcode won't or couldn't(??) interpreted or executed.
It this a possible reason ?

The following code is, what i could see via "view page source code" within my newest firefox browser:

Code:

<!-- Plugin Statistics -->
<!-- Piwik -->
<script type="text/javascript">
  var _paq = _paq || [];
  // you can set up to 5 custom variables for each visitor

  _paq.push(["setCustomVariable", 1, "UserID", document.getElementById('my_user_id').innerHTML, "visit"]);
  _paq.push(['trackPageView']);
  _paq.push(['enableLinkTracking']);
  (function() {
    var u="//piwik.domain.de/";
    _paq.push(['setTrackerUrl', u+'piwik.php']);
    _paq.push(['setSiteId', 1]);
    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+'piwik.js'; s.parentNode.insertBefore(g,s);
  })();
</script>
<noscript><p><img src="//piwik.domain.de/piwik.php?idsite=1" style="border:0;" alt="" /></p></noscript>
<!-- End Piwik Code -->

<!-- Plugin Statistics -->

In my mind the function "document.getElementById('my_user_id').innerHTML" was not executed, or the personal plugin was not called. Of course, i have activated this since my last some answers.

Sorry for the trouble, but i'am not familar with javascript or php code writing. Does Piwigo has a debug or tracking function wich help as a little bit more for the debugging here?

Blaufotograph · 2015-10-03 22:27:20

Hi @All, hello Mistic100,

i have a screenshot, from my generated sourcecode in my site. As i mentioned in my last post, the function wont be executed and the variable wont be replaced.

Could you please have a look at my screenshot?

Last edited by Blaufotograph (2015-10-03 22:31:32)

mistic100 · 2015-10-03 22:32:22

as I already said : this is NORMAL, I won't teach you JavaScript here.

now you just have to check on Piwik that the value is here

Blaufotograph · 2015-10-03 22:49:20

mistic100 wrote:
as I already said : this is NORMAL, I won't teach you JavaScript here.

now you just have to check on Piwik that the value is here

Thank you very much. Of course i understand, that you couldn't teach me in Javascript. Please excuse me, if i maybe waste your time. I appreciate your help very much.

I checked now my piwik instance, and found the UserID "3".

Now my next steps will be to find out, how i could find out the real user and translate it to the text interpration.

I hope this thread will help also other users with the same issue.

Kind regards and thank you very much,

Axel Birndt

Blaufotograph · 2015-10-06 22:18:49

plg wrote:
Interesting! Maybe a start to a better integration with Piwik :-)

Hi PLG, hello mistic100,

I've now successful implemented my plugin and changed my parameters to track the HTTP_REMOTE UserID from the Apacheserver too.

Here is the php-code for the personal plugin like described from you, mistic100, and changed from me for my needs:

* plugins/PersonalPlugin/main.inc.php

Code:

<?php
/*
Plugin Name: Personal Plugin to fill in the UserID and the HTTP-User
Version: 1.0
Description: Personal Plugin for fill in the UserID and the HTTP-User from the Apache-Server Environment
Plugin URI: http://piwigo.org/???
Author: Example from mistic100, extended from blaufotograph
Author URI: http://www.2axels-company.de
*/
/*
Plugin Name: add hidden USER_ID
*/

add_event_handler('loc_end_page_header', 'add_user_id');
add_event_handler('loc_end_page_header', 'add_http_user_id');
 
function add_user_id()
{
  global $template, $user;
  $template->assign('MY_USER_ID', $user['username']); // HERE you can replace $user['id'] by something else
  $template->set_prefilter('header', 'add_user_id_prefilter', 100);
}
 
function add_user_id_prefilter($content)
{
  return $content . "\n" . '<span style="display:none" id="my_user_id">{$MY_USER_ID}</span>';
}

function add_http_user_id()
{
  global $template, $user;
  $template->assign('HTTP_USER_ID', $_SERVER['REMOTE_USER']); // HERE you can replace $user['id'] by something else. Additional i'am trying to setup the RemoteUser from the Apache Environment
  $template->set_prefilter('header', 'add_http_id_prefilter', 100);
}

function add_http_id_prefilter($content)
{
  return $content . "\n" . '<span style="display:none" id="http_user_id">{$HTTP_USER_ID}</span>';
}

?>

Into the normal Piwik Javascript Tracking code you should fill in the following lines to track the UserID(resp. the logged in user in Piwigo) and the HTTP REMOTE_USER from the Apache Environment:

Code:

<!-- Piwik -->
<script type="text/javascript">
  var _paq = _paq || [];
  // you can set up to 5 custom variables for each visitor

  _paq.push(["setCustomVariable", 1, "LoggedInUser", document.getElementById('my_user_id').innerHTML, "visit"]);
  _paq.push(["setCustomVariable", 2, "HTTPRemoteUser", document.getElementById('http_user_id').innerHTML, "visit"]);
  _paq.push(['trackPageView']);
[...]

Inside Piwik you will see the logged IDs and Users like below:

LoggedInUser : username<x>
HTTPRemoteUser : username<x>

@Plg,

Maybe it is a good idea to create a plugin (maybe especially for Piwik) to setup some user defined php-Variables which could then be used inside the Javascript tracking code or for any other purposes.
My idea is to make it easier to include the values from php Variables. My first painful steps in this way was described above. As i understand your Piwigo Gallery, you do the filtering of any other code, inside the statistics plugin.

Ok, now i'am looking forward expectantly to the future, what you are thinking about this idea ?

Kind regards,

Axel Birndt

Last edited by Blaufotograph (2015-10-06 22:19:23)

mistic100 · 2015-10-06 22:32:47

Shrink the personal plugin with:

Code:

<?php
/*
Plugin Name: Personal Plugin to fill in the UserID and the HTTP-User
Version: 1.0
Description: Personal Plugin for fill in the UserID and the HTTP-User from the Apache-Server Environment
Author: Example from mistic100, extended from blaufotograph
Author URI: http://www.2axels-company.de
*/

add_event_handler('loc_end_page_header', 'add_user_id');
 
function add_user_id()
{
  global $template, $user;
  $template->assign('MY_USER_ID', $user['username']);
  $template->assign('HTTP_USER_ID', $_SERVER['REMOTE_USER']);
  $template->set_prefilter('header', 'add_user_id_prefilter', 100);
}
 
function add_user_id_prefilter($content)
{
  return $content . "\n"
    . '<span style="display:none" id="my_user_id">{$MY_USER_ID}</span>'
    . '<span style="display:none" id="http_user_id">{$HTTP_USER_ID}</span>';
}

?>

Piwigo.org

Announcement

#1 2015-09-05 22:03:02

piwigo Trouble with including Piwik code within the Statistics Plugin

Code:

#2 2015-09-25 21:38:18

Re: piwigo Trouble with including Piwik code within the Statistics Plugin

#3 2015-09-25 23:16:46

Re: piwigo Trouble with including Piwik code within the Statistics Plugin

Code:

Code:

Code:

#4 2015-09-26 08:28:09

Re: piwigo Trouble with including Piwik code within the Statistics Plugin

#5 2015-09-27 18:09:35

Re: piwigo Trouble with including Piwik code within the Statistics Plugin

mistic100 wrote:

Code:

#6 2015-09-29 22:28:04

Re: piwigo Trouble with including Piwik code within the Statistics Plugin

Code:

Code:

#7 2015-09-29 22:43:33

Re: piwigo Trouble with including Piwik code within the Statistics Plugin

Code:

Code:

#8 2015-09-30 22:16:39

Re: piwigo Trouble with including Piwik code within the Statistics Plugin

mistic100 wrote:

Code:

Code:

#9 2015-09-30 22:21:49

Re: piwigo Trouble with including Piwik code within the Statistics Plugin

Code:

#10 2015-10-01 07:34:52

Re: piwigo Trouble with including Piwik code within the Statistics Plugin

mistic100 wrote:

Code:

Code:

#11 2015-10-03 22:27:20

Re: piwigo Trouble with including Piwik code within the Statistics Plugin

#12 2015-10-03 22:32:22

Re: piwigo Trouble with including Piwik code within the Statistics Plugin

#13 2015-10-03 22:49:20

Re: piwigo Trouble with including Piwik code within the Statistics Plugin

mistic100 wrote:

#14 2015-10-06 22:18:49

Re: piwigo Trouble with including Piwik code within the Statistics Plugin

plg wrote:

Code:

Code:

#15 2015-10-06 22:32:47

Re: piwigo Trouble with including Piwik code within the Statistics Plugin

Code:

Board footer