Recherche avancée

Sur d’autres sites (11559)

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

• Can I convert a django video upload from a form using ffmpeg before storing the video ?

  5 mai 2014, par GetItDone

  I’ve been stuck for weeks trying to use ffmpeg to convert user uploaded videos to flv. I use heroku to host my website, and store my static and media files on amazon S3 with s3boto. The initial video file will upload fine, however when I retrieve the video and run a celery task (in the same view where the initial video file is uploaded), the new file won’t store on S3. I’ve been trying to get this to work for over a month, with no luck, and really no good resources available for learning how to do this, so I figure maybe if I can get the ffmpeg task to run before storing the video I may be able to get it to work. Unfortunately I’m still not a very advanced at python (or django), so I don’t even know if/how this is possible. Anyone have any ideas ? I am willing to use any solution at this point no matter how ugly, as long as it successfully takes video uploads and converts to flv using ffmpeg, with the resulting file being stored on S3. It doesn’t seem that my situation is very common, because no matter where I look, I cannot find a solution that explains what I should be trying to do. Therefore I will be very appreciative of any guidance. Thanks. My relevant code follows :

  #models.py
  
  def content_file_name(instance, filename):
  
      ext = filename.split('.')[-1]
  
      new_file_name = "remove%s.%s" % (uuid.uuid4(), ext)
  
      return '/'.join(['videos', instance.teacher.username, new_file_name])
  
  
  
  class BroadcastUpload(models.Model):
  
      title = models.CharField(max_length=50, verbose_name=_('Title'))
  
      description = models.TextField(max_length=100, verbose_name=_('Description'))
  
      teacher = models.ForeignKey(User, null=True, blank=True, related_name='teacher')
  
      created_date = models.DateTimeField(auto_now_add=True)
  
      video_upload = models.FileField(upload_to=content_file_name)
  
      flvfilename = models.CharField(max_length=100, null=True, blank=True)
  
      videothumbnail = models.CharField(max_length=100, null=True, blank=True)
  
  
  
  #tasks.py
  
  @task(name='celeryfiles.tasks.convert_flv')
  
  def convert_flv(video_id):
  
      video = BroadcastUpload.objects.get(pk=video_id)
  
      print "ID: %s" % video.id
  
      id = video.id
  
      print "VIDEO NAME: %s" % video.video_upload.name
  
      teacher = video.teacher
  
      print "TEACHER: %s" % teacher
  
      filename = video.video_upload
  
      sourcefile = "%s%s" % (settings.MEDIA_URL, filename)
  
      vidfilename = "%s_%s.flv" % (teacher, video.id)
  
      targetfile = "%svideos/flv/%s" % (settings.MEDIA_URL, vidfilename)
  
      ffmpeg = "ffmpeg -i %s %s" % (sourcefile, vidfilename)
  
      try:
  
          ffmpegresult = subprocess.call(ffmpeg)
  
          #also tried separately with following line:
  
          #ffmpegresult = commands.getoutput(ffmpeg)
  
          print "---------------FFMPEG---------------"
  
          print "FFMPEGRESULT: %s" % ffmpegresult
  
      except Exception as e:
  
          ffmpegresult = None
  
          print("Failed to convert video file %s to %s" % (sourcefile, targetfile))
  
          print(traceback.format_exc())
  
      video.flvfilename = vidfilename
  
      video.save()
  
  
  
  @task(name='celeryfiles.tasks.ffmpeg_image')        
  
  def ffmpeg_image(video_id):
  
      video = BroadcastUpload.objects.get(pk=video_id)
  
      print "ID: %s" %video.id
  
      id = video.id
  
      print "VIDEO NAME: %s" % video.video_upload.name
  
      teacher = video.teacher
  
      print "TEACHER: %s" % teacher
  
      filename = video.video_upload
  
      sourcefile = "%s%s" % (settings.MEDIA_URL, filename)
  
      imagefilename = "%s_%s.png" % (teacher, video.id)
  
      thumbnailfilename = "%svideos/flv/%s" % (settings.MEDIA_URL, thumbnailfilename)
  
      grabimage = "ffmpeg -y -i %s -vframes 1 -ss 00:00:02 -an -vcodec png -f rawvideo -s 320x240 %s" % (sourcefile, thumbnailfilename)
  
      try:        
  
           videothumbnail = subprocess.call(grabimage)
  
           #also tried separately following line:
  
           #videothumbnail = commands.getoutput(grabimage)
  
           print "---------------IMAGE---------------"
  
           print "VIDEOTHUMBNAIL: %s" % videothumbnail
  
      except Exception as e:
  
           videothumbnail = None
  
           print("Failed to convert video file %s to %s" % (sourcefile, thumbnailfilename))
  
           print(traceback.format_exc())
  
      video.videothumbnail = imagefilename
  
      video.save()
  
  
  
  #views.py
  
  def upload_broadcast(request):
  
      if request.method == 'POST':
  
          form = BroadcastUploadForm(request.POST, request.FILES)
  
          if form.is_valid():
  
              upload=form.save()
  
              video_id = upload.id
  
              image_grab = ffmpeg_image.delay(video_id)
  
              video_conversion = convert_flv.delay(video_id)
  
              return HttpResponseRedirect('/current_classes/')
  
      else:
  
          form = BroadcastUploadForm(initial={'teacher': request.user,})
  
      return render_to_response('videos/create_video.html', {'form': form,}, context_instance=RequestContext(request))
  
  
  
  #settings.py
  
  DEFAULT_FILE_STORAGE = 'myapp.s3utils.MediaRootS3BotoStorage'
  
  DEFAULT_S3_PATH = "media"
  
  STATICFILES_STORAGE = 'myapp.s3utils.StaticRootS3BotoStorage'
  
  STATIC_S3_PATH = "static"
  
  AWS_STORAGE_BUCKET_NAME = 'my_bucket'
  
  CLOUDFRONT_DOMAIN = 'domain.cloudfront.net'
  
  AWS_ACCESS_KEY_ID = 'MY_KEY_ID'
  
  AWS_SECRET_ACCESS_KEY = 'MY_SECRET_KEY'
  
  MEDIA_ROOT = '/%s/' % DEFAULT_S3_PATH
  
  MEDIA_URL = 'http://%s/%s/' % (CLOUDFRONT_DOMAIN, DEFAULT_S3_PATH)
  
  ...
  
  
  
  #s3utils.py
  
  from storages.backends.s3boto import S3BotoStorage
  
  from django.utils.functional import SimpleLazyObject
  
  
  
  StaticRootS3BotoStorage = lambda: S3BotoStorage(location='static')
  
  MediaRootS3BotoStorage  = lambda: S3BotoStorage(location='media')

  I can add any other info if needed to help me solve my problem.

• Grand Unified Theory of Compact Disc

  1er février 2013, par Multimedia Mike — General

  This is something I started writing about a decade ago (and I almost certainly have some of it wrong), back when compact discs still had a fair amount of relevance. Back around 2002, after a few years investigating multimedia technology, I took an interest in compact discs of all sorts. Even though there may seem to be a wide range of CD types, I generally found that they’re all fundamentally the same. I thought I would finally publishing something, incomplete though it may be.

  Physical Perspective
  There are a lot of ways to look at a compact disc. First, there’s the physical format, where a laser detects where pits/grooves have disturbed the smooth surface (a.k.a. lands). A lot of technical descriptions claim that these lands and pits on a CD correspond to ones and zeros. That’s not actually true, but you have to decide what level of abstraction you care about, and that abstraction is good enough if you only care about the discs from a software perspective.

  Grand Unified Theory (Software Perspective)
  Looking at a disc from a software perspective, I have generally found it useful to view a CD as a combination of a 2 main components :

  • table of contents (TOC)
  • a long string of sectors, each of which is 2352 bytes long

  I like to believe that’s pretty much all there is to it. All of the information on a CD is stored as a string of sectors that might be chopped up into a series of anywhere from 1-99 individual tracks. The exact sector locations where these individual tracks begin are defined in the TOC.

  Audio CDs (CD-DA / Red Book)
  The initial purpose for the compact disc was to store digital audio. The strange sector size of 2352 bytes is an artifact of this original charter. “CD quality audio”, as any multimedia nerd knows, is formally defined as stereo PCM samples that are each 16 bits wide and played at a frequency of 44100 Hz.
  

  (44100 audio frames / 1 second) * (2 samples / audio frame) * 
    (16 bits / 1 sample) * (1 byte / 8 bits) = 176,400 bytes / second
  (176,400 bytes / 1 second) / (2352 bytes / 1 sector) = 75
  

  75 is the number of sectors required to store a single second of CD-quality audio. A single sector stores 1/75th of a second, or a ‘frame’ of audio (though I think ‘frame’ gets tossed around at all levels when describing CD formats).

  The term “red book” is thrown around in relation to audio CDs. There is a series of rainbow books that define various optical disc standards and the red book describes audio CDs.

  Basic Data CD-ROMs (Mode 1 / Yellow Book)
  Somewhere along the line, someone decided that general digital information could be stored on these discs. Hence, the CD-ROM was born. The standard model above still applies– TOC and string of 2352-byte sectors. However, it’s generally only useful to have a single track on a CD-ROM. Thus, the TOC only lists a single track. That single track can easily span the entire disc (something that would be unusual for a typical audio CD).

  While the model is mostly the same, the most notable difference between and audio CD and a plain CD-ROM is that, while each sector is 2352 bytes long, only 2048 bytes are used to store actual data payload. The remaining bytes are used for synchronization and additional error detection/correction.

  At least, the foregoing is true for mode 1 / form 1 CD-ROMs (which are the most common). “Mode 1″ CD-ROMs are defined by a publication called the yellow book. There is also mode 1 / form 2. This forgoes the additional error detection and correction afforded by form 1 and dedicates 2336 of the 2352 sector bytes to the data payload.

  CD-ROM XA (Mode 2 / Green Book)
  From a software perspective, these are similar to mode 1 CD-ROMs. There are also 2 forms here. The first form gives a 2048-byte data payload while the second form yields a 2324-byte data payload.

  Video CD (VCD / White Book)
  These are CD-ROM XA discs that carry MPEG-1 video and audio data.

  Photo CD (Beige Book)
  This is something I have never personally dealt with. But it’s supposed to conform to the CD-ROM XA standard and probably fits into my model. It seems to date back to early in the CD-ROM era when CDs were particularly cost prohibitive.

  Multisession CDs (Blue Book)
  Okay, I admit that this confuses me a bit. Multisession discs allow a user to burn multiple sessions to a single recordable disc. I.e., burn a lump of data, then burn another lump at a later time, and the final result will look like all the lumps were recorded as the same big lump. I remember this being incredibly useful and cost effective back when recordable CDs cost around US$10 each (vs. being able to buy a spindle of 100 CD-Rs for US$10 or less now). Studying the cdrom.h file for the Linux OS, I found a system call named CDROMMULTISESSION that returns the sector address of the start of the last session. If I were to hypothesize about how to make this fit into my model, I might guess that the TOC has some hint that the disc was recorded in multisession (which needs to be decided up front) and the CDROMMULTISESSION call is made to find the last session. Or it could be that a disc read initialization operation always leads off with the CDROMMULTISESSION query in order to determine this.

  I suppose I could figure out how to create a multisession disc with modern software, or possibly dig up a multisession disc from 15+ years ago, and then figure out how it should be read.

  CD-i
  This type puzzles my as well. I do have some CD-i discs and I thought that I could read them just fine (the last time I looked, which was many years ago). But my research for this blog post has me thinking that I might not have been seeing the entire picture when I first studied my CD-i samples. I was able to see some of the data, but sources indicate that only proper CD-i hardware is able to see all of the data on the disc (apparently, the TOC doesn’t show all of the sectors on disc).

  Hybrid CDs (Data + Audio)
  At some point, it became a notable selling point for an audio CD to have a data track with bonus features. Even more common (particularly in the early era of CD-ROMs) were computer and console games that used the first track of a disc for all the game code and assets and the remaining tracks for beautifully rendered game audio that could also be enjoyed outside the game. Same model : TOC points to the various tracks and also makes notes about which ones are data and which are audio.

  There seems to be 2 distinct things described above. One type is the mixed mode CD which generally has the data in the first track and the audio in tracks 2..n. Then there is the enhanced CD, which apparently used multisession recording and put the data at the end. I think that the reasoning for this is that most audio CD player hardware would only read tracks from the first session and would have no way to see the data track. This was a positive thing. By contrast, when placing a mixed-mode CD into an audio player, the data track would be rendered as nonsense noise.

  Subchannels
  There’s at least one small detail that my model ignores : subchannels. CDs can encode bits of data in subchannels in sectors. This is used for things like CD-Text and CD-G. I may need to revisit this.

  In Summary
  There’s still a lot of ground to cover, like how those sectors might be formatted to show something useful (e.g., filesystems), and how the model applies to other types of optical discs. Sounds like something for another post.