Recherche avancée

Sur d’autres sites (15127)

• How to create a scheduled task – Introducing the Piwik Platform

  28 août 2014, par Thomas Steur — Development

  This is the next post of our blog series where we introduce the capabilities of the Piwik platform (our previous post was How to create a custom theme in Piwik). This time you’ll learn how to execute scheduled tasks in the background, for instance sending a daily email. For this tutorial you will need to have basic knowledge of PHP.

  What can you do with scheduled tasks ?

  Scheduled tasks let you execute tasks regularly (hourly, weekly, …). For instance you can :

  • create and send custom reports or summaries
  • sync users and websites with other systems
  • clear any caches
  • import third-party data into Piwik
  • monitor your Piwik instance
  • execute any other task you can think of

  Getting started

  In this series of posts, we assume that you have already set up your development environment. If not, visit the Piwik Developer Zone where you’ll find the tutorial Setting up Piwik.

  To summarize the things you have to do to get setup :

  • Install Piwik (for instance via git).
  • Activate the developer mode : ./console development:enable --full.
  • Generate a plugin : ./console generate:plugin --name="MyTasksPlugin". There should now be a folder plugins/MyTasksPlugin.
  • And activate the created plugin under Settings => Plugins.

  Let’s start creating a scheduled task

  We start by using the Piwik Console to create a tasks template :

  ./console generate:scheduledtask

  The command will ask you to enter the name of the plugin the task should belong to. I will simply use the above generated plugin name “MyTasksPlugin”. There should now be a file plugins/MyTasksPlugin/Tasks.php which contains some examples to get you started easily :

  class Tasks extends \Piwik\Plugin\Tasks
  
  {
  
      public function schedule()
  
      {
  
          $this->hourly('myTask');  // method will be executed once every hour
  
          $this->daily('myTask');   // method will be executed once every day
  
          $this->weekly('myTask');  // method will be executed once every week
  
          $this->monthly('myTask'); // method will be executed once every month
  
  
  
          // pass a parameter to the task
  
          $this->weekly('myTaskWithParam', 'anystring');
  
  
  
          // specify a different priority
  
          $this->monthly('myTask', null, self::LOWEST_PRIORITY);
  
          $this->monthly('myTaskWithParam', 'anystring', self::HIGH_PRIORITY);
  
      }
  
  
  
      public function myTask()
  
      {
  
          // do something
  
      }
  
  
  
      public function myTaskWithParam($param)
  
      {
  
          // do something
  
      }
  
  }

  A simple example

  As you can see in the generated template you can execute tasks hourly, daily, weekly and monthly by registering a method which represents the actual task :

  public function schedule()
  
  {
  
      // register method remindMeToLogIn to be executed once every day
  
      $this->daily('remindMeToLogIn');  
  
  }
  
  
  
  public function remindMeToLogIn()
  
  {
  
      $mail = new \Piwik\Mail();
  
      $mail->addTo('me@example.com');
  
      $mail->setSubject('Check stats');
  
      $mail->setBodyText('Log into your Piwik instance and check your stats!');
  
      $mail->send();
  
  }

  This example sends you an email once a day to remind you to log into your Piwik daily. The Piwik platform makes sure to execute the method remindMeToLogIn exactly once every day.

  How to pass a parameter to a task

  Sometimes you want to pass a parameter to a task method. This is useful if you want to register for instance one task for each user or for each website. You can achieve this by specifying a second parameter when registering the method to execute.

  public function schedule()
  
  {
  
      foreach (\Piwik\Site::getSites() as $site) {
  
          // create one task for each site and pass the URL of each site to the task
  
          $this->hourly('pingSite', $site['main_url']); 
  
      }
  
  }
  
  
  
  public function pingSite($siteMainUrl)
  
  {
  
      file_get_contents($siteMainUrl);
  
  }

  How to test scheduled tasks

  After you have created your task you are surely wondering how to test it. First, you should write a unit or integration test which we will cover in one of our future blog posts. Just one hint : You can use the command ./console generate:test to create a test. To manually execute all scheduled tasks you can execute the API method CoreAdminHome.runScheduledTasks by opening the following URL in your browser :

  http://piwik.example.com/index.php?module=API&method=CoreAdminHome.runScheduledTasks&token_auth=YOUR_API_TOKEN

  Don’t forget to replace the domain and the token_auth URL parameter.

  There is one problem with executing the scheduled tasks : The platform makes sure they will be executed only once an hour, a day, etc. This means you can’t simply reload the URL and test the method again and again as you would have to wait for the next hour or day. The proper solution is to set the constant DEBUG_FORCE_SCHEDULED_TASKS to true within the file Core/TaskScheduler.php. Don’t forget to set it back to false again once you have finished testing it.

  Starting from Piwik 2.6.0 you can alternatively execute the following command :

  ./console core:run-scheduled-tasks --force --token-auth=YOUR_TOKEN_AUTH

  The option “–force” will make sure to execute even tasks that are not due to run at this time. So you won’t have to modify any files.

  Which tasks are registered and when is the next execution time of my task ?

  The TasksTimetable plugin from the Marketplace can answer this question for you. Simply install and activate the plugin with one click by going to Settings => Marketplace => Get new functionality. It’ll add a new admin menu item under Settings named Scheduled Tasks.

  Publishing your Plugin on the Marketplace

  In case you want to share your task(s) with other Piwik users you can do this by pushing your plugin to a public GitHub repository and creating a tag. Easy as that. Read more about how to distribute a plugin.

  Advanced features

  Isn’t it easy to create scheduled tasks ? We never even created a file ! Of course, based on our API design principle “The complexity of our API should never exceed the complexity of your use case.” you can accomplish more if you want. For instance, you can define priorities, you can directly register methods from different objects and classes, you can specify at which time of a day a task should run and more.

  Would you like to know more about tasks ? Go to our Tasks class reference in the Piwik Developer Zone.

  If you have any feedback regarding our APIs or our guides in the Developer Zone feel free to send it to us.

• How to create a scheduled task – Introducing the Piwik Platform

  28 août 2014, par Thomas Steur — Development

  This is the next post of our blog series where we introduce the capabilities of the Piwik platform (our previous post was How to create a custom theme in Piwik). This time you’ll learn how to execute scheduled tasks in the background, for instance sending a daily email. For this tutorial you will need to have basic knowledge of PHP.

  What can you do with scheduled tasks ?

  Scheduled tasks let you execute tasks regularly (hourly, weekly, …). For instance you can :

  • create and send custom reports or summaries
  • sync users and websites with other systems
  • clear any caches
  • import third-party data into Piwik
  • monitor your Piwik instance
  • execute any other task you can think of

  Getting started

  In this series of posts, we assume that you have already set up your development environment. If not, visit the Piwik Developer Zone where you’ll find the tutorial Setting up Piwik.

  To summarize the things you have to do to get setup :

  • Install Piwik (for instance via git).
  • Activate the developer mode : ./console development:enable --full.
  • Generate a plugin : ./console generate:plugin --name="MyTasksPlugin". There should now be a folder plugins/MyTasksPlugin.
  • And activate the created plugin under Settings => Plugins.

  Let’s start creating a scheduled task

  We start by using the Piwik Console to create a tasks template :

  ./console generate:scheduledtask

  The command will ask you to enter the name of the plugin the task should belong to. I will simply use the above generated plugin name “MyTasksPlugin”. There should now be a file plugins/MyTasksPlugin/Tasks.php which contains some examples to get you started easily :

  class Tasks extends \Piwik\Plugin\Tasks
  
  {
  
      public function schedule()
  
      {
  
          $this->hourly('myTask');  // method will be executed once every hour
  
          $this->daily('myTask');   // method will be executed once every day
  
          $this->weekly('myTask');  // method will be executed once every week
  
          $this->monthly('myTask'); // method will be executed once every month
  
  
  
          // pass a parameter to the task
  
          $this->weekly('myTaskWithParam', 'anystring');
  
  
  
          // specify a different priority
  
          $this->monthly('myTask', null, self::LOWEST_PRIORITY);
  
          $this->monthly('myTaskWithParam', 'anystring', self::HIGH_PRIORITY);
  
      }
  
  
  
      public function myTask()
  
      {
  
          // do something
  
      }
  
  
  
      public function myTaskWithParam($param)
  
      {
  
          // do something
  
      }
  
  }

  A simple example

  As you can see in the generated template you can execute tasks hourly, daily, weekly and monthly by registering a method which represents the actual task :

  public function schedule()
  
  {
  
      // register method remindMeToLogIn to be executed once every day
  
      $this->daily('remindMeToLogIn');  
  
  }
  
  
  
  public function remindMeToLogIn()
  
  {
  
      $mail = new \Piwik\Mail();
  
      $mail->addTo('me@example.com');
  
      $mail->setSubject('Check stats');
  
      $mail->setBodyText('Log into your Piwik instance and check your stats!');
  
      $mail->send();
  
  }

  This example sends you an email once a day to remind you to log into your Piwik daily. The Piwik platform makes sure to execute the method remindMeToLogIn exactly once every day.

  How to pass a parameter to a task

  Sometimes you want to pass a parameter to a task method. This is useful if you want to register for instance one task for each user or for each website. You can achieve this by specifying a second parameter when registering the method to execute.

  public function schedule()
  
  {
  
      foreach (\Piwik\Site::getSites() as $site) {
  
          // create one task for each site and pass the URL of each site to the task
  
          $this->hourly('pingSite', $site['main_url']); 
  
      }
  
  }
  
  
  
  public function pingSite($siteMainUrl)
  
  {
  
      file_get_contents($siteMainUrl);
  
  }

  How to test scheduled tasks

  After you have created your task you are surely wondering how to test it. First, you should write a unit or integration test which we will cover in one of our future blog posts. Just one hint : You can use the command ./console generate:test to create a test. To manually execute all scheduled tasks you can execute the API method CoreAdminHome.runScheduledTasks by opening the following URL in your browser :

  http://piwik.example.com/index.php?module=API&method=CoreAdminHome.runScheduledTasks&token_auth=YOUR_API_TOKEN

  Don’t forget to replace the domain and the token_auth URL parameter.

  There is one problem with executing the scheduled tasks : The platform makes sure they will be executed only once an hour, a day, etc. This means you can’t simply reload the URL and test the method again and again as you would have to wait for the next hour or day. The proper solution is to set the constant DEBUG_FORCE_SCHEDULED_TASKS to true within the file Core/TaskScheduler.php. Don’t forget to set it back to false again once you have finished testing it.

  Starting from Piwik 2.6.0 you can alternatively execute the following command :

  ./console core:run-scheduled-tasks --force --token-auth=YOUR_TOKEN_AUTH

  The option “–force” will make sure to execute even tasks that are not due to run at this time. So you won’t have to modify any files.

  Which tasks are registered and when is the next execution time of my task ?

  The TasksTimetable plugin from the Marketplace can answer this question for you. Simply install and activate the plugin with one click by going to Settings => Marketplace => Get new functionality. It’ll add a new admin menu item under Settings named Scheduled Tasks.

  Publishing your Plugin on the Marketplace

  In case you want to share your task(s) with other Piwik users you can do this by pushing your plugin to a public GitHub repository and creating a tag. Easy as that. Read more about how to distribute a plugin.

  Advanced features

  Isn’t it easy to create scheduled tasks ? We never even created a file ! Of course, based on our API design principle “The complexity of our API should never exceed the complexity of your use case.” you can accomplish more if you want. For instance, you can define priorities, you can directly register methods from different objects and classes, you can specify at which time of a day a task should run and more.

  Would you like to know more about tasks ? Go to our Tasks class reference in the Piwik Developer Zone.

  If you have any feedback regarding our APIs or our guides in the Developer Zone feel free to send it to us.

• Data Privacy Day 2020

  27 janvier 2020, par Matthieu Aubry — Privacy
  It’s January 28th which means it’s Data Privacy Day !

  Today is an important day for the Matomo team as we reflect on our mission and our goals for 2020. This year I wanted to send a video message to all Matomo users, community members and customers. 

  Check it out (full transcript below)

  

  A video message from Matomo founder, Matthieu Aubry

  Privacy-friendly alternatives

  • NoMoreGoogle :
    a comprehensive list giving you options for other privacy-friendly alternatives.
  • Switching.Software :
    Ethical alternatives to popular sites and apps.
  • Web browser :
    Firefox
    Brave
    Vivaldi
  • Search engine :
    DuckDuckGo
    Qwant
  • File sharing :
    Nextcloud
  • Email provider :
    ProtonMail
    Mailfence
    Tutanota

  Video transcript

  Hey everyone,

  Matthieu here, Founder of Matomo.

  Today is one of the most significant days of the year for the Matomo team – it’s Data Privacy Day. And so I wanted to quickly reflect on our mission and the significance of this day. 

  In today’s busy online world where data is king, this day is an important reminder of being vigilant in protecting our personal information online.

  Matomo began 12 years ago as an open-source alternative to Google Analytics – the goal was, and still is to give full control of data back to users. 

  In 2020, we are determined to see through this commitment. We will keep building a powerful and ethical web analytics platform that focuses on privacy protection, data ownership, and provides value to all Matomo users and customers.

  And what’s fantastic is to see the rise of other quality software companies offering privacy-friendly alternatives for web browsers, search engines, file sharing, email providers, all with a similar mission. And with these products now widely available, we encourage you to take back control of all your online activities and begin this new decade with a resolution to stay safe online.

  I’ll provide you with some links below the video to check out these privacy-friendly alternatives. If you have a website and want to gain valuable insights on the visitors while owning your data, join us ! 

  Matomo Analytics On-Premise is and always will be free to download and install on your own servers and on your own terms.

  Also feel free to join our active community or spread the word to your friends and network about the importance of data privacy.

  Thank you all and wishing you a great 2020 !

  For more information on how Matomo protects the privacy of your users, visit : https://matomo.org/privacy/

  Do you have privacy concerns ?

  What better day than today to speak up ! What privacy concerns have you experienced ?

  Contact Support