Recherche avancée

Sur d’autres sites (8381)

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

• Revision 60e01c6530 : Account for eob cost in the RTC mode decision process This commit accounts for

  3 avril 2015, par Jingning Han

  Changed Paths :
   Modify /vp9/encoder/vp9_pickmode.c

  
  
  Account for eob cost in the RTC mode decision process

  This commit accounts for the transform block end of coefficient flag
  cost in the RTC mode decision process. This allows a more precise
  rate estimate. It also turns on the model to block sizes up to 32x32.
  The test sequences shows about 3% - 5% speed penalty for speed -6.
  The average compression performance improvement for speed -6 is
  1.58% in PSNR. The compression gains for hard clips like jimredvga,
  mmmoving, and tacomascmv at low bit-rate range are 1.8%, 2.1%, and
  3.2%, respectively.

  Change-Id : Ic2ae211888e25a93979eac56b274c6e5ebcc21fb

• FFMPEG error with avformat_open_input returning -135

  28 avril 2015, par LawfulEvil

  I have a DLL one of my applications uses to receive video from RTSP cameras. Under the hood, the DLL uses FFMPEG libs from this release zip :

  ffmpeg-20141022-git-6dc99fd-win64-shared.7z

  We have a wide variety of cameras in house and most of them work just fine. However, on one particular Pelco Model Number : IXE20DN-OCP, I am unable to connect. I tested the camera and rtsp connection string on VLC and it connects to the camera just fine.

  I found the connection string here : http://www.ispyconnect.com/man.aspx?n=Pelco

  rtsp://IPADDRESS:554/1/stream1

  Oddly, even if I leave the port off of VLC, it connects, so I’m guessing its the default RTSP port or that VLC tries a variety of things based on your input.

  In any case, when I attempt to connect, I get an error from av_format_open_input. It returns a code of -135. When I looked in the error code list I didn’t see that listed. For good measure, I printed out all the errors in error.h just to see what their values were.

  DumpErrorCodes - Error Code : AVERROR_BSF_NOT_FOUND = -1179861752
  
  DumpErrorCodes - Error Code : AVERROR_BUG = -558323010
  
  DumpErrorCodes - Error Code : AVERROR_BUFFER_TOO_SMALL = -1397118274
  
  DumpErrorCodes - Error Code : AVERROR_DECODER_NOT_FOUND = -1128613112
  
  DumpErrorCodes - Error Code : AVERROR_DEMUXER_NOT_FOUND = -1296385272
  
  DumpErrorCodes - Error Code : AVERROR_ENCODER_NOT_FOUND = -1129203192
  
  DumpErrorCodes - Error Code : AVERROR_EOF = -541478725
  
  DumpErrorCodes - Error Code : AVERROR_EXIT = -1414092869
  
  DumpErrorCodes - Error Code : AVERROR_EXTERNAL = -542398533
  
  DumpErrorCodes - Error Code : AVERROR_FILTER_NOT_FOUND = -1279870712
  
  DumpErrorCodes - Error Code : AVERROR_INVALIDDATA = -1094995529
  
  DumpErrorCodes - Error Code : AVERROR_MUXER_NOT_FOUND = -1481985528
  
  DumpErrorCodes - Error Code : AVERROR_OPTION_NOT_FOUND = -1414549496
  
  DumpErrorCodes - Error Code : AVERROR_PATCHWELCOME = -1163346256
  
  DumpErrorCodes - Error Code : AVERROR_PROTOCOL_NOT_FOUND = -1330794744
  
  DumpErrorCodes - Error Code : AVERROR_STREAM_NOT_FOUND = -1381258232
  
  DumpErrorCodes - Error Code : AVERROR_BUG2 = -541545794
  
  DumpErrorCodes - Error Code : AVERROR_UNKNOWN = -1313558101
  
  DumpErrorCodes - Error Code : AVERROR_EXPERIMENTAL = -733130664
  
  DumpErrorCodes - Error Code : AVERROR_INPUT_CHANGED = -1668179713
  
  DumpErrorCodes - Error Code : AVERROR_OUTPUT_CHANGED = -1668179714
  
  DumpErrorCodes - Error Code : AVERROR_HTTP_BAD_REQUEST = -808465656
  
  DumpErrorCodes - Error Code : AVERROR_HTTP_UNAUTHORIZED = -825242872
  
  DumpErrorCodes - Error Code : AVERROR_HTTP_FORBIDDEN = -858797304
  
  DumpErrorCodes - Error Code : AVERROR_HTTP_NOT_FOUND = -875574520
  
  DumpErrorCodes - Error Code : AVERROR_HTTP_OTHER_4XX = -1482175736
  
  DumpErrorCodes - Error Code : AVERROR_HTTP_SERVER_ERROR = -1482175992

  Nothing even close to -135. I did find this error, sort of on stack overflow, here runtime error when linking ffmpeg libraries in qt creator where the author claims it is a DLL loading problem error. I’m not sure what led him to think that, but I followed the advice and used the dependency walker (http://www.dependencywalker.com/) to checkout what dependencies it thought my DLL needed. It listed a few, but they were already provided in my install package.

  To make sure it was picking them up, I manually removed them from the install and observed a radical change in program behavior(that being my DLL didn’t load and start to run at all).

  So, I’ve got a bit of init code :

  void FfmpegInitialize()
  
  {
  
   av_lockmgr_register(&LockManagerCb);
  
   av_register_all();
  
   LOG_DEBUG0("av_register_all returned\n");
  
  }

  Then I’ve got my main open connection routine ...

  int RTSPConnect(const char *URL, int width, int height, frameReceived callbackFunction)
  
  {
  
  
  
      int errCode =0;
  
      if ((errCode = avformat_network_init()) != 0)
  
      {
  
          LOG_ERROR1("avformat_network_init returned error code %d\n", errCode);  
  
      }
  
      LOG_DEBUG0("avformat_network_init returned\n");
  
      //Allocate space and setup the the object to be used for storing all info needed for this connection
  
      fContextReadFrame = avformat_alloc_context(); // free'd in the Close method
  
  
  
      if (fContextReadFrame == 0)
  
      {
  
          LOG_ERROR1("Unable to set rtsp_transport options.   Error code = %d\n", errCode);
  
          return FFMPEG_OPTION_SET_FAILURE;
  
      }
  
  
  
      LOG_DEBUG1("avformat_alloc_context returned %p\n", fContextReadFrame);
  
  
  
      AVDictionary *opts = 0;
  
      if ((errCode = av_dict_set(&opts, "rtsp_transport", "tcp", 0)) < 0)
  
      {
  
          LOG_ERROR1("Unable to set rtsp_transport options.   Error code = %d\n", errCode);
  
          return FFMPEG_OPTION_SET_FAILURE;
  
      }
  
      LOG_DEBUG1("av_dict_set returned %d\n", errCode);
  
  
  
      //open rtsp
  
      DumpErrorCodes();
  
      if ((errCode = avformat_open_input(&fContextReadFrame, URL, NULL, &opts)) < 0)
  
      {
  
          LOG_ERROR2("Unable to open avFormat RF inputs.   URL = %s, and Error code = %d\n", URL, errCode);       
  
          LOG_ERROR2("Error Code %d = %s\n", errCode, errMsg(errCode));       
  
          // NOTE context is free'd on failure.
  
          return FFMPEG_FORMAT_OPEN_FAILURE;
  
      }
  
  ...

  To be sure I didn’t misunderstand the error code I printed the error message from ffmpeg but the error isn’t found and my canned error message is returned instead.

  My next step was going to be hooking up wireshark on my connection attempt and on the VLC connection attempt and trying to figure out what differences(if any) are causing the problem and what I can do to ffmpeg to make it work. As I said, I’ve got a dozen other cameras in house that use RTSP and they work with my DLL. Some utilize usernames/passwords/etc as well(so I know that isn’t the problem).

  Also, my run logs :

  FfmpegInitialize - av_register_all returned
  
  Open - Open called.  Pointers valid, passing control.
  
  Rtsp::RtspInterface::Open - Rtsp::RtspInterface::Open called
  
  Rtsp::RtspInterface::Open - VideoSourceString(35) = rtsp://192.168.14.60:554/1/stream1
  
  Rtsp::RtspInterface::Open - Base URL = (192.168.14.60:554/1/stream1)
  
  Rtsp::RtspInterface::Open - Attempting to open (rtsp://192.168.14.60:554/1/stream1) for WxH(320x240) video
  
  RTSPSetFormatH264 - RTSPSetFormatH264
  
  RTSPConnect - Called
  
  LockManagerCb - LockManagerCb invoked for op 1
  
  LockManagerCb - LockManagerCb invoked for op 2
  
  RTSPConnect - avformat_network_init returned
  
  RTSPConnect - avformat_alloc_context returned 019E6000
  
  RTSPConnect - av_dict_set returned 0
  
  DumpErrorCodes - Error Code : AVERROR_BSF_NOT_FOUND = -1179861752
  
  ...
  
  DumpErrorCodes - Error Code : AVERROR_HTTP_SERVER_ERROR = -1482175992
  
  RTSPConnect - Unable to open avFormat RF inputs.   URL = rtsp://192.168.14.60:554/1/stream1, and Error code = -135
  
  RTSPConnect - Error Code -135 = No Error Message Available

  I’m going to move forward with wireshark but would like to know the origin of the -135 error code from ffmpeg. When I look at the code if ’ret’ is getting set to -135, it must be happening as a result of the return code from a helper method and not directly in the avformat_open_input method.

  https://www.ffmpeg.org/doxygen/2.5/libavformat_2utils_8c_source.html#l00398

  After upgrading to the latest daily ffmpeg build, I get data on wireshark. Real Time Streaming Protocol :

  Request: SETUP rtsp://192.168.14.60/stream1/track1 RTSP/1.0\r\n
  
  Method: SETUP
  
  URL: rtsp://192.168.14.60/stream1/track1
  
  Transport: RTP/AVP/TCP;unicast;interleaved=0-1
  
  CSeq: 3\r\n
  
  User-Agent: Lavf56.31.100\r\n
  
  \r\n

  The response to that is the first ’error’ that I can detect in the initiation.

  Response: RTSP/1.0 461 Unsupported Transport\r\n
  
  Status: 461
  
  CSeq: 3\r\n
  
  Date: Sun, Jan 04 1970 16:03:05 GMT\r\n
  
  \r\n

  I’m going to guess that... it means the transport we selected was unsupported. I quick check of the code reveals I picked ’tcp’. Looking through the reply to the DESCRIBE command, it appears :

  Media Protocol: RTP/AVP

  Further, when SETUP is issued by ffmpeg, it specifies :

  Transport: RTP/AVP/TCP;unicast;interleaved=0-1

  I’m going to try, on failure here to pick another transport type and see how that works. Still don’t know where the -135 comes from.