give the user the option if anonymous data will sent #8346

rdeutz · 2015-11-08T20:22:29Z

updated PR description: #8346 (comment)

Original PR description:This PR implements a 6 hour grace time before a site sends data to the stats server. So anyone is able to disable the pluging before data will be send.

This PR implements a 6 hour grace time before a site sends data to the stats server. So anyone is able to disable the pluging before data will be send.

zero-24 · 2015-11-08T20:45:56Z

@rdeutz can you add this "6 hour grace time" to the postinstall message too?

infograf768 · 2015-11-09T07:45:33Z

@rdeutz can you add this "6 hour grace time" to the postinstall message too?

Agree.

rdeutz · 2015-11-09T07:54:59Z

@infograf768 @zero-24 I also agree to add this to the post-install if we find testers and merge it

infograf768 · 2015-11-09T08:10:33Z

Made a new install. Will let you know exactly when the message is sent (if sent).

rdeutz · 2015-11-09T09:40:18Z

I have testet the delay now, in fact it gives 6 + 12 hours because we are checking if the delay between last run and now is bigger then 12 hours. That makes it 18 hours after install what is more then enough to disable a plugin. Atm it fails, I think it is because the stats server isn't running but I will check it.

#How to test

if you have a tool like LittleSnitch you can control network connections and see if there is something going out
You can set a breakpoint at line 93, if the execution stops the connection will go out.

wilsonge · 2015-11-09T12:19:44Z

The stats server has been running since 4/11/15

rdeutz · 2015-11-09T12:47:47Z

@wilsonge could also be me being not fast enough to allow the connection in LittleSnitch

rdeutz · 2015-11-09T13:06:45Z

disabled the network filter and it works, but my test doesn't count :-)

phproberto · 2015-11-10T02:10:13Z

I have sent a new PR to @rdeutz rdeutz#2

Now on first run the plugin will show a message asking the user to select the mode it will use:

This allows users to:

Always allow to send data.
Send data once and get asked next time the stats try to get sent.
Never send data.

That message will be shown the first time the plugin is loaded and never again except user selects Once option that will ask the user permission each time the plugin wants to send new data.

In the plugin parameters I have added also some options to configure it:

So now the users can adjust:

Interval for new stats being sent.
Mode of the plugin
Enable debug mode to test the plugin.

Bakual · 2015-11-10T07:19:19Z

You change basically makes it opt-in. We wanted it opt-out explicitely.

If you want to make it opt-in, you can as well just deliver it unpublished and show a postinstall message where people can enable it. No need for any special code then.

infograf768 · 2015-11-10T07:31:42Z

I have tested this item ✅ successfully on 25abae2

When loading my test site this morning, the first thing it did was trying to get https://developer.joomla.org

So, a good test for me.

_{This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/8346.}

phproberto · 2015-11-10T07:46:59Z

I don't think it's opt-in or opt-out. It's opt. No decision is taken for the user.

A disabled plugin + postinstall message wouldn't be so easy to setup for users. It would require 2-3 clicks to explicitly enable it. Here you hace both options in 30 pixels and 1 click away. I don't think is the same...

If you think that nobody is going to enable it then is a bad idea to put it there without asking users.

Bakual · 2015-11-10T09:23:37Z

I don't think it's opt-in or opt-out. It's opt. No decision is taken for the user.

I assume if the user doesn't click anything, it will not send anything. Thus it's opt-in. The user has to actively enable it.

phproberto · 2015-11-10T09:31:49Z

I assume if the user doesn't click anything, it will not send anything. Thus it's opt-in. The user has to actively enable it.

Users have to actively enable OR disable it. The only mandatory thing (if user doesn't want to live with a message always shown in backend) is that they decide the initial mode.

Thus it's just opt :P

phproberto · 2015-11-10T09:47:25Z

PR updated!

Bakual · 2015-11-10T09:59:31Z

Users have to actively enable OR disable it.

The question is what happens if they don't do anything? Answer is: It doesn't send any data. Thus it's opt-in.
Granted, they keep having an annoying message on the screen until they disable it. Similar to postinstall messages, but more annoying 😄

Allow users to accept & configure stats sending

joomla-cms-bot · 2015-11-10T09:59:43Z

This PR has received new commits.

CC: @infograf768

_{This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/8346.}

rdeutz · 2015-11-10T10:01:39Z

@Bakual we bug them since they make a decision :-)

brianteeman · 2015-11-10T10:16:45Z

administrator/language/en-GB/en-GB.plg_system_stats.ini

+PLG_SYSTEM_STATS_INTERVAL_DESC="Stats will be sent each X hours. Default is 12"
+PLG_SYSTEM_STATS_INTERVAL_LABEL="Interval (hours)"
+PLG_SYSTEM_STATS_LABEL_MESSAGE_TITLE="Joomla! would like your permission collect some basic statistics."
+PLG_SYSTEM_STATS_MODE_DESC="Selec the way you want that statistics are sent"


+PLG_SYSTEM_STATS_MODE_DESC="Select the way that you want the statistics to be sent."

rdeutz · 2015-11-10T10:17:58Z

@infograf768 deleting the params for the plugin should do the job

brianteeman · 2015-11-10T10:19:49Z

administrator/language/en-GB/en-GB.plg_system_stats.ini

@@ -4,9 +4,23 @@
 ; Note : All ini files need to be saved as UTF-8

 PLG_SYSTEM_STATS="System - Joomla! Statistics"


For reference the style guide says

Whenever you can substitute "your Joomla CMS" in place of "Joomla" and still make sense, then it's descriptive and no bang needed.
So in this case I erred on J to mean the project and not the CMS so does need the !

phproberto · 2015-11-10T10:19:53Z

rdeutz#3

Fix typos

joomla-cms-bot · 2015-11-10T10:21:26Z

This PR has received new commits.

CC: @infograf768

_{This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/8346.}

infograf768 · 2015-11-10T10:28:15Z

@rdeutz
does not work here after deleting params = I do not get the Notice in Control Panel

infograf768 · 2015-11-10T10:33:49Z

Found out: the plugin has to be enabled first (as it does for updates or new installs)
Works nicely!

infograf768 · 2015-11-10T10:36:43Z

I have tested this item ✅ successfully on 6d8f1b7

_{This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/8346.}

phproberto · 2015-11-10T10:46:59Z

I missed one typo. rdeutz#4

BTW Thanks for checking this @brianteeman @infograf768 !

Hils · 2015-11-10T11:59:43Z

administrator/language/en-GB/en-GB.plg_system_stats.ini

+PLG_SYSTEM_STATS_MODE_OPTION_NEVER_SEND="Never send"
+PLG_SYSTEM_STATS_MODE_OPTION_ON_DEMAND="On demand"
+PLG_SYSTEM_STATS_MSG_ALLOW_SENDING_DATA="Enable Joomla Statistics?"
+PLG_SYSTEM_STATS_MSG_JOOMLA_WANTS_TO_SEND_DATA="In order to better understand our install base and end user environments, this plugin has been created to send those statistics back to a Joomla! controlled central server. No identifying data is captured at any point. You can change this settings later from Plugins > System Joomla! Statistics."


Line 21 "...You can change this settings later from..." should be "change this setting"

Good spot - I am not wondering if it should be
change these settings

@Hils what do you think

Could be either - I can't look at the context just now (away) - maybe settings is more comfortable?

Webdongle · 2015-11-10T12:07:21Z

I have tested this item ✅ successfully on 6d8f1b7

@rdeutz Great thanks

@jtester works

_{This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/8346.}

Missed typo

joomla-cms-bot · 2015-11-10T13:03:53Z

This PR has received new commits.

CC: @infograf768, @Webdongle

_{This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/8346.}

phproberto · 2015-11-10T14:36:47Z

I used "these changes" because there is more than one setting being applied.

rdeutz#6

Yet more typos :( We can squash when we merge it finally

joomla-cms-bot · 2015-11-10T14:39:09Z

This PR has received new commits.

CC: @infograf768, @Webdongle

_{This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/8346.}

Chris-Jones-Gill · 2015-11-10T15:15:23Z

Tested in 2 ways, with slightly differing results.

Methods

Update from 3.4.5 to 3.5.0-beta, apply patch for PR using PatchTester
New 3.5.0-beta install, but applying this PR before opening in browser

Results

open System - Control Panel
No decision box shown.
New post install message indicated.
New message reads

Stats Collection in Joomla

Since version 3.5.0

Since Joomla 3.5 Joomla contains an anonymous statistics tracking plugin that provides your Joomla version, PHP version, database engine and version, and server operating system. This data is collected in order to ensure that as we develop new versions of Joomla we provide the most optimal software taking advantage of the latest database and PHP features but without loosing significant numbers of users. It became especially clear this was required after the requirement of PHP 5.3.10 was implemented after the release of Joomla 3.3 for implementation of BCrypt passwords.

We are making this data publicly available through our API and we will be providing graphs representing the Joomla version, PHP versions and database engines of sites reporting their data in the interest of transparency to the community and to help 3rd party developers.

If you do not wish to provide the Joomla! project with this information you can simply disable the plugin called System - Joomla! Statistics

Open Plugins -> System - Joomla Statistics
All options showing, but mode is set to "Always send"

I guess that nobody would update a live system in this manner anyway, but I have included the results as a point of interest.

Works as expected
First login to Adminstrator looks like this...

infograf768 · 2015-11-10T15:27:34Z

2 tests. RTC

_{This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/8346.}

wilsonge · 2015-11-10T15:37:40Z

Thanks guys :) Merged

give the user the option if anonymous data will sent

grace time for sending data for the first time

59f0ade

This PR implements a 6 hour grace time before a site sends data to the stats server. So anyone is able to disable the pluging before data will be send.

joomla-cms-bot added the PR-staging label Nov 8, 2015

fix comments style

25abae2

rdeutz added this to the Joomla! 3.5.0 milestone Nov 8, 2015

This was referenced Nov 9, 2015

Add anonymous stats collection plugin #8291

Merged

Run the stats plugin only on cpanel #8320

Closed

[imp] allow users to accept & configure stats sending

3399721

phproberto mentioned this pull request Nov 10, 2015

Allow users to accept & configure stats sending rdeutz/joomla-cms#2

Merged

[imp] remove stats plugin url setting & move debug to advanced

7fe7473

[imp] always send system stats using AJAX

67fe07a

Merge pull request #2 from phproberto/rdeutz-8346

a0f977c

Allow users to accept & configure stats sending

joomla-cms-bot added the Language Change This is for Translators label Nov 10, 2015

brianteeman reviewed Nov 10, 2015
View reviewed changes

[fix] typos

cad7d0f

brianteeman reviewed Nov 10, 2015
View reviewed changes

Merge pull request #3 from phproberto/rdeutz-8346

6d8f1b7

Fix typos

[fix] missed typo

effc5bd

Hils reviewed Nov 10, 2015
View reviewed changes

Merge pull request #4 from phproberto/rdeutz-8346

9aff8ff

Missed typo

[fix] yet more typos :(

2bb0220

Merge pull request #6 from phproberto/rdeutz-8346

75445ef

Yet more typos :( We can squash when we merge it finally

joomla-cms-bot added the RTC This Pull Request is Ready To Commit label Nov 10, 2015

wilsonge added a commit that referenced this pull request Nov 10, 2015

Merge pull request #8346 from rdeutz/implement_first_run_delay

d814580

give the user the option if anonymous data will sent

wilsonge merged commit d814580 into joomla:staging Nov 10, 2015

rdeutz deleted the implement_first_run_delay branch November 16, 2015 21:12

wilsonge removed the RTC This Pull Request is Ready To Commit label Jan 17, 2016

ghost mentioned this pull request Apr 20, 2018

Add a Telemetry module to (anonymously) collect useful data backdrop/backdrop-issues#285

Closed

3 tasks

		@@ -4,9 +4,23 @@
		; Note : All ini files need to be saved as UTF-8

		PLG_SYSTEM_STATS="System - Joomla! Statistics"

give the user the option if anonymous data will sent #8346

give the user the option if anonymous data will sent #8346

Conversation

rdeutz commented Nov 8, 2015

zero-24 commented Nov 8, 2015

infograf768 commented Nov 9, 2015

rdeutz commented Nov 9, 2015

infograf768 commented Nov 9, 2015

rdeutz commented Nov 9, 2015

wilsonge commented Nov 9, 2015

rdeutz commented Nov 9, 2015

rdeutz commented Nov 9, 2015

phproberto commented Nov 10, 2015

Bakual commented Nov 10, 2015

infograf768 commented Nov 10, 2015

phproberto commented Nov 10, 2015

Bakual commented Nov 10, 2015

phproberto commented Nov 10, 2015

phproberto commented Nov 10, 2015

Bakual commented Nov 10, 2015

joomla-cms-bot commented Nov 10, 2015

rdeutz commented Nov 10, 2015

brianteeman Nov 10, 2015

Choose a reason for hiding this comment

rdeutz commented Nov 10, 2015

brianteeman Nov 10, 2015

Choose a reason for hiding this comment

phproberto commented Nov 10, 2015

joomla-cms-bot commented Nov 10, 2015

infograf768 commented Nov 10, 2015

infograf768 commented Nov 10, 2015

infograf768 commented Nov 10, 2015

phproberto commented Nov 10, 2015

Hils Nov 10, 2015

Choose a reason for hiding this comment

brianteeman Nov 10, 2015

Choose a reason for hiding this comment

Hils Nov 10, 2015

Choose a reason for hiding this comment

Webdongle commented Nov 10, 2015

joomla-cms-bot commented Nov 10, 2015

phproberto commented Nov 10, 2015

joomla-cms-bot commented Nov 10, 2015

Chris-Jones-Gill commented Nov 10, 2015

Methods

Results

infograf768 commented Nov 10, 2015

wilsonge commented Nov 10, 2015