Recherche avancée

Sur d’autres sites (4881)

• 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.

• Ffmpeg send duration of video to client (using node-fluent-ffmpeg)

  26 mai 2013, par Vprnl

  I'm really new to the world of ffmpeg so please excuses me if this is a stupid queston.

  I'm using the module Node-fluent-ffmpeg to stream a movie and convert it from avi to webm with FFMPEG.

  So far so good (it plays the video), but I'm having trouble parsing the duration to the player. It also gives me an error even though I plays the video.

  my code is as followed :

  var stat = fs.statSync(movie);
  
  
  
  var start = 0;
  
  var end = 0;
  
  var range = req.header('Range');
  
  if (range != null) {
  
  start = parseInt(range.slice(range.indexOf('bytes=')+6,
  
    range.indexOf('-')));
  
  end = parseInt(range.slice(range.indexOf('-')+1,
  
    range.length));
  
  }
  
  if (isNaN(end) || end == 0) end = stat.size-1;
  
  if (start > end) return;
  
  
  
  var duration = (end / 1024) * 8 / 1024;
  
  
  
  res.writeHead(206, { // NOTE: a partial http response
  
      'Connection':'close',
  
      'Content-Type':'video/webm',
  
      'Content-Length':end - start,
  
      'Content-Range':'bytes '+start+'-'+end+'/'+stat.size,
  
      'Transfer-Encoding':'chunked'
  
  });
  
  
  
  var proc = new ffmpeg({ source: movie, nolog: true, priority: 1, timeout:15000})
  
      .toFormat('webm')
  
      .addOptions(['-probesize 900000', '-analyzeduration 0', '-minrate 1024k', '-maxrate 1024k', '-bufsize 1835k', '-t '+duration+' -ss'])
  
      .writeToStream(res, function(retcode, error){
  
      if (!error){
  
          console.log('file has been converted succesfully',retcode);
  
      }else{
  
          console.log('file conversion error',error);
  
      }
  
  });

  I set the header with a start and a end based on this article : http://delog.wordpress.com/2011/04/25/stream-webm-file-to-chrome-using-node-js/

  I calculate the length in seconds in the variable duration.

  The error FFmpeg is giving me is :

      file conversion error ffmpeg version N-52458-gaa96439 Copyright (c) 2000-2013 the FFmpeg developers
  
        built on Apr 24 2013 22:19:32 with gcc 4.8.0 (GCC)
  
        configuration: --enable-gpl --enable-version3 --disable-w32threads --enable-avisynth --enable-bzlib --enable-fontconfig --e
  
      nable-frei0r --enable-gnutls --enable-iconv --enable-libass --enable-libbluray --enable-libcaca --enable-libfreetype --enable
  
      -libgsm --enable-libilbc --enable-libmp3lame --enable-libopencore-amrnb --enable-libopencore-amrwb --enable-libopenjpeg --ena
  
      ble-libopus --enable-librtmp --enable-libschroedinger --enable-libsoxr --enable-libspeex --enable-libtheora --enable-libtwola
  
      me --enable-libvo-aacenc --enable-libvo-amrwbenc --enable-libvorbis --enable-libvpx --enable-libx264 --enable-libxavs --enabl
  
      e-libxvid --enable-zlib
  
        libavutil      52. 27.101 / 52. 27.101
  
        libavcodec     55.  6.100 / 55.  6.100
  
        libavformat    55.  3.100 / 55.  3.100
  
        libavdevice    55.  0.100 / 55.  0.100
  
        libavfilter     3. 60.101 /  3. 60.101
  
        libswscale      2.  2.100 /  2.  2.100
  
        libswresample   0. 17.102 /  0. 17.102
  
        libpostproc    52.  3.100 / 52.  3.100
  
      Input #0, avi, from 'C:/temp/test.avi':
  
        Metadata:
  
          encoder         : Nandub v1.0rc2
  
        Duration: 00:01:09.78, start: 0.000000, bitrate: 1517 kb/s
  
          Stream #0:0: Video: msmpeg4v3 (DIV3 / 0x33564944), yuv420p, 640x352, 23.98 tbr, 23.98 tbn, 23.98 tbc
  
          Stream #0:1: Audio: mp3 (U[0][0][0] / 0x0055), 48000 Hz, stereo, s16p, 222 kb/s
  
      [libvpx @ 0036db20] v1.2.0
  
      Output #0, webm, to 'pipe:1':
  
        Metadata:
  
          encoder         : Lavf55.3.100
  
          Stream #0:0: Video: vp8, yuv420p, 640x352, q=-1--1, 200 kb/s, 1k tbn, 23.98 tbc
  
          Stream #0:1: Audio: vorbis, 48000 Hz, stereo, fltp
  
      Stream mapping:
  
        Stream #0:0 -> #0:0 (msmpeg4 -> libvpx)
  
        Stream #0:1 -> #0:1 (mp3 -> libvorbis)

  The client side player (which is VideoJs) says the file is infinite/NaN in length.

  I feel like I'm pretty close to a solution but my inexperience with the subject matter prohibits me from getting it to work. If I'm unclear in any way please let me know. (I have a tendency of explaining things fuzzy.)

  Thanks in advance !

  [EDIT]

  I removed the duration bit because it has nothing to do with the issue. I checked the response header of the client and saw :

   Accept-Ranges:bytes
  
   Connection:keep-alive
  
   Content-Length:13232127
  
   Content-Range:bytes 0-13232127/13232128
  
   Content-Type:video/webm

  Why can't the client figure out the duration even though it receives it in the header ?

• How to add new pages and menu items to Piwik – Introducing the Piwik Platform

  11 septembre 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 widget). This time you’ll learn how to extend Piwik by adding new pages and menu items. For this tutorial you will need to have basic knowledge of PHP and optionally of Twig which is the template engine we use.

  What can be displayed in a page ?

  To make it short : You can display any corporate related content, key metrics, news, help pages, custom reports, contact details, information about your server, forms to manage any data and anything else.

  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="MyControllerPlugin". There should now be a folder plugins/MyControllerPlugin.
  • And activate the created plugin under Settings => Plugins.

  Let’s start creating a page

  We start by using the Piwik Console to create a new page :

  ./console generate:controller

  The command will ask you to enter the name of the plugin the controller should belong to. I will simply use the above chosen plugin name “MyControllerPlugin”. There should now be two files plugins/MyControllerPlugin/Controller.php and plugins/MyControllerPlugin/templates/index.twig which both already contain an example to get you started easily :

  Controller.php

  class Controller extends \Piwik\Plugin\Controller
  {
      public function index()
      {
          return $this->renderTemplate('index', array(
               'answerToLife' => 42
          ));
      }
  }
  Télécharger

  and templates/index.twig

  {% extends 'dashboard.twig' %}
   
  {% block content %}
      <strong>Hello world!</strong>
      <br/>
   
      The answer to life is {{ answerToLife }}
  {% endblock %}
  Télécharger

  Note : If you are generating the Controller before Piwik 2.7.0 the example will look slightly different.

  The controller action index assigns the view variable answerToLife to the view and renders the Twig template templates/index.twig. Any variable assigned this way can then be used in the view using for example {{ answerToLife }}.

  Using a Twig template to generate the content of your page is actually optional : instead feel free to generate any content as desired and return a string in your controller action.

  As the above template index.twig is extending the dashboard template the Logo as well as the top menu will automatically appear on top of your content which is defined within the block content.

  

  How to display the page within the admin

  If you would like to add the admin menu on the left you have to modify the following parts :

  • Extend \Piwik\Plugin\ControllerAdmin instead of \Piwik\Plugin\Controller in the file Controller.php. In a future version of Piwik this step will be no longer neccessary, see #6151
  • Extend the template admin.twig instead of dashboard.twig
  • Define a headline using an H2-element

  {% extends 'admin.twig' %}
   
  {% block content %}
      <h2>Hello world!</h2>
      <br/>
   
      The answer to life is {{ answerToLife }}
  {% endblock %}
  Télécharger

  Note : Often one needs to add a page to the admin to make a plugin configurable. We have a unified solution for this using the Settings API.

  

  How to display a blank page

  If you would like to generate a blank page that shows only your content the template should contain only your markup as follows :

  <strong>Hello world!</strong>
  <br/>
   
  The answer to life is {{ answerToLife }}
  Télécharger

  Predefined variables, UI components, security and accessing query parameters

  In this blog post we only cover the basics to get you started. We highly recommend to read the MVC guide on our developer pages which covers some of those advanced topics. For instance you might be wondering how to securely access $_GET or $_POST parameters, you might want to restrict the content of your page depending on a user role, and much more.

  If you would like to know how to make use of JavaScript, CSS and Less have a look at our Working with Piwik’s UI guide.

  Note : How to include existing UI components such as a site selector or a date selector will be covered in a future blog post. Also, there are default variables assigned to the view depending on the context. A list of those variables that may or may not be defined is unfortunately not available yet but we will catch up on this.

  Let’s add a menu item to make the page accessible

  So far you have created a page but you can still not access it. Therefore we need to add a menu item to one of the Piwik menus. We start by using the Piwik Console to create a menu template :

  ./console generate:menu

  The command will ask you to enter the name of the plugin the menu should belong to. I will use again the above chosen plugin name “MyControllerPlugin”. There should now be a file plugins/MyControllerPlugin/Menu.php which contains an example to get you started easily :

  Menu.php

  class Menu extends \Piwik\Plugin\Menu
  {
      public function configureUserMenu(MenuUser $menu)
      {
          // reuse an existing category. 
          $menu->addManageItem('My User Item', $this->urlForAction('showList'));
   
          // or create a custom category
          $menu->addItem('My Custom Category', 'My User Item', $this->urlForDefaultAction());
      }
  }
  Télécharger

  This is only a part of the generated template since all the examples of the different menus are similar. You can add items to four menus :

  • configureReportingMenu To add a new item to the reporting menu which includes all the reports like “Actions” and “Visitors”.
  • configureAdminMenu To add a new item to the admin menu which includes items like “User settings” and “Websites”.
  • configureTopMenu To add a new item to the top menu which includes items like “All Websites” and “Logout”.
  • configureUserMenu To add a new item to the user menu which is accessible when clicking on the username on the top right.

  In this blog post we will add a new item to the user menu and to do so we adjust the generated template like this :

  class Menu extends \Piwik\Plugin\Menu
  {
      public function configureUserMenu(MenuUser $menu)
      {
          $menu->addManageItem('My User Item', $this->urlForAction($method = 'index'), $orderId = 30);
      }
  }
  Télécharger

  That’s it. This will add a menu item named “My User Item” to the “Manage” section of the user menu. When a user chooses the menu item, the “index” method of your controller will be executed and your previously created page will be first rendered and then displayed. Optionally, you can define an order to influence the position of the menu item within the manage section. Following this example you can add an item to any menu for any action. I think you get the point !

  

  Note : In Piwik 2.6.0 and before the above example would look like this :

  class Menu extends \Piwik\Plugin\Menu
  {
      public function configureUserMenu(MenuUser $menu)
      {
          $menu->addManageItem('My User Item', array($module = 'MyControllerPlugin', $action = 'index'), $orderId = 30);
      }
  }
  Télécharger

  How to test a page

  After you have created your page you are surely wondering how to test it. A controller should be usually very simple as it is only the connector between model and view. Therefore, we do usually not create unit or integration test for controllers and for the view less than ever. Instead we would create a UI test that takes a screenshot of your page and compares it with an expected screenshot. Luckily, there is already a section UI tests in our Automated tests guide.

  Publishing your Plugin on the Marketplace

  In case you want to share your page 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 a page ? 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 : You can make use of Vanilla JavaScript, jQuery, AngularJS, Less and CSS, you can reuse UI components, you can access query parameters and much more.

  Would you like to know more about this ? Go to our MVC (Model-View-Controller) and Working with Piwik’s UI guides 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.