New Kernel, Wireless Drivers, and Ubuntu Natty beta.

Decided to do yet another update to all the images, including updating the Kernel to 2.6.38.2. This kernel as well as some multitasking responsiveness improvements brings a fix to the EFI framebuffer that solves the palette corruption issue. Now all the distribution’s fancy bootscreens work as they should. I also built a DKMS package with the vendor wireless drivers, after reports from users it gives better stability and wireless N support.

As an added bonus, I also include a download to an Ubuntu Natty beta image. Note that it’s preset to the “classic” desktop. You can log out and then log back in with “Unity 2D” to see one of the newer interfaces, but it still seemed somewhat buggy here. Unity 3D does not work with the current EMGD drivers however.

    Changes include:

  • Updated Kernel to 2.6.38.2 – Includes fix for EFI framebuffer palette bug, so graphical boots now look right
  • Packaged vendor wireless driver due to reports of improved stability and better wireless N support
  • Beta version of Ubuntu Natty image for testing

New versions of all Linux images (again)

Another update for all images. Sorry to do one so soon after the last (It has been a lot of work this weekend – after this i’m having a rest!). There were some stability concerns with the last images, and I have done some tweaks and performance improvements. The latest images work well for me in testing so far, and fingers crossed they will work for you too.

    Changes include:

  • Use NOOP io scheduler by default that should be faster on USB flash devices
  • Shutdown/Reboot should be more reliable
  • Use text splash screens on boot
  • Updated firmware for the wireless card

New versions of all Linux images, including Joli OS 1.2

The Jolicloud OS has been renamed to Joli OS, to avoid confusion with their online desktop app. With this change, the new 1.2 version was also released bringing new functionality and performance – see http://www.jolicloud.com/blog/2011/03/09/welcome-to-the-new-jolicloud/. The 1.2 version has now been adapted for the Joggler and can be downloaded from the Jolicloud page.

Ubuntu Maverick and Linux Mint have also been updated. Changes include an updated kernel (2.6.37.3) and a new btrfs with the much faster lzo compression.

Updates for all distributions

All distributions have been updated to include XBMC, the latest Squeezeplay and a build of mplayer (in /usr/local/bin) with VA-API support for hardware accelerated video playback. For this reason they are a little bigger, but it’s quite easy to slim them down by removing applications you don’t use.

XBMC comes preinstalled with the iPlayer plugin (http://code.google.com/p/xbmc-iplayerv2/ as well as a skin developed for the joggler that can be enabled from the settings. Please note that music visualisers are not currently working, so you will need to disable them from within xbmc if they have not already been.

If you already have the last version, you may wish to just install xbmc yourself from my Joggler PPA. Instructions to do this are on the relevant distribution pages.

XBMC now available

The popular media player XBMC is now available for the Joggler on Ubuntu Maverick, Jolicloud, and Linux Mint 10. To install XBMC please make sure you have the latest image and run the following commands from a terminal.

sudo apt-get update
sudo apt-get upgrade
sudo apt-get install xbmc

You can then run it from a terminal by typing “xbmc” or load it from the normal Ubuntu/Linux Mint menus. On Jolicloud you can add it to “Local Apps” to run it from the main interface. Please note that the music visualisers do not currently work, so before playing music the visualiser needs to be set to “none” from within the xbmc settings.

XBMC will be included by default in the next update to the distributions.

Magento Connect/Pear channel not updated ?

We manage our Magento shops in source control, but upgrade extensions as needed via Pear and Magento’s channels. However since mid December 2009, no upgrades have been showing up. Looking at the pages on the Magento site, there are upgrades available for some of the extensions we are running, but they are no longer being shown. I wonder if some meta data for the pear channel is not being updated correctly?


$ ./pear list-upgrades
Channel connect.magentocommerce.com/community: No upgrades available
Channel connect.magentocommerce.com/core: No upgrades available

I am not the only one with this problem, as someone posted to the Magento Connect forum (http://www.magentocommerce.com/boards/viewthread/73424/). This isn’t my normal kind of post, but I’m hoping someone with the power to fix this will notice.

Sorry for the lack of posts here. I have not been working with Magento that much in recent months. I do have some other short articles  planned though. If you need any development work feel free to contact me (jools [at] oxfordinspire.co.uk).

Setting default options for configurable products

We are using the configurable products feature of Magento to group together some of our products that differ for example only by colour or number of items in a pack. In our case there is just a single “option” for the product and we wanted it to default to the “first” option in the dropdown, rather than the Magento default of forcing the user to choose an option.

As the dropdown for a configurable product is filled in on the client side with javascript this required some javascript code to “switch” to the first option and then reload the price. Here is the javascript we used to do this . This is a diff file to be applied against the /design/frontend/default/default/template/catalog/product/view/type/options/configurable.phtml file. This path will differ when you are using your own skin.

Index: view/type/options/configurable.phtml
===================================================================
--- view/type/options/configurable.phtml	(revision 73)
+++ view/type/options/configurable.phtml	(revision 74)
@@ -42,5 +42,10 @@
     </dl>
     <script type="text/javascript">
         var spConfig = new Product.Config(<?php echo $this->getJsonConfig() ?>);
+        // set the defaults to the first option
+        for(var i=spConfig.settings.length-1;i>=0;i--) {
+          spConfig.settings[i].selectedIndex = 1;
+        }
+        spConfig.reloadPrice();
     </script>
 <?php endif;?>

*Update*

Unfortunately the code doesn’t work as expected on IE due to http://support.microsoft.com/kb/927917 “Message: HTML Parsing Error: Unable to modify the parent container element before the child element is closed (KB927917)”.  My fix was to just disable this for now for IE by wrapping the changes in

if ( ! Prototype.Browser.IE ) {
...
}

If anyone knows a workaround for this, please let me know! Did I mention how much I hate IE? !

Creating a simple news feed module (for display within static blocks)

Here I will explain how I implemented a simple news feed feature that can be used inside static blocks. Before creating this, I had a look, and only found a commercial offering for this, so I hope this is of use to other people. It also was a learning experience for me, as it is the first code I have done for Magento that utilises a custom template.

To save myself a little work, I took an off the shelf RSS and Atom feed parser called “Simplepie”. This might not have been the best choice as there are a couple of issues with it. Firstly it is reasonably large, and no doubt does a lot more than I require. Secondly, I had some problems getting it to work with Magento. This was due to simplepie having php4 compatibility, and because I like to run my php5 with E_STRICT error reporting, php complained. This however was a quick fix and I will cover that later. If anyone knows a modern, compact php5 rss/atom parser that is any good, please do let me know.

First let’s start then with simplepie, the modifications to make to it, and where to  install it. Paths referenced in these instructions should be considered relative to the Magento root folder.

Download the latest simplepie archive from the website (http://simplepie.org/). At the time of writing this is version 1.1.3. Unpack it somewhere. Create a folder in your Magento installation called lib/simplepie.

Copy the simplepie.inc and the idn folder (and any LICENCE.txt etc) to the magento/lib/simplepie folder. You should now have a folder structure similar to

lib/simplepie/
              LICENSE.txt
              simplepie.inc
              idn/
                  idna_convert.class.php
                  LICENCE
                  npdata.ser
                  ReadMe.txt

Now we will make some simple modifications to the simplepie.inc file (and also rename it to simplepie.class.php – this is just my own preference). Simplepie includes php4 compatibility that could cause problems running on php5 depending on your error reporting settings. The following sed commandline will correct this so simplepie will not cause errors and will ingrate with Magento on a PHP5 setup with E_STRICT error reporting.

sed -e "s/& new/ new/g" simplepie.inc >simplepie.class.php

After running this, you can remove the old simplepie.inc. There are some other things within the simplepie code that will also cause problems running in E_STRICT mode on php5, but we can work around this by changing the error reporting level in our module. I will explain this further on.

Our newsfeed module will be stored in app/code/local/Maglife/Newsfeeds. The Maglife folder is our module namespace, and the Newsfeeds is the name of the module. The structure here is as follows

app/code/local/Maglife/Newsfeeds/
                                 Block/
                                       View.php
                                 etc/
                                     config.xml

The file View.php contains the main module code, and the config.xml contains the module configuration, including version number, and class name.

File: app/code/local/Maglife/Newsfeeds/etc/config.xml
This file contains the module configuration including module version number and our module class.

<?xml version="1.0" encoding="UTF-8"?>
<config>
    <modules>
        <Maglife_Newsfeeds>
            <version>0.1.0</version>
        </Maglife_Newsfeeds>
    </modules>
    <global>
        <blocks>
            <Maglife_Newsfeeds>
                <class>Maglife_Newsfeeds_Block</class>
            </Maglife_Newsfeeds>
        </blocks>
    </global>
</config>

File: app/code/local/Maglife/Newsfeeds/Block/View.php

This file contain the main code for our module. Our module will also have a template file, that also contains some code, but the bulk of the work is done here, so that the template is kept as simple as possible.

Note that we include the idna_convert.class.php first, as otherwise there are issues with the class being autoloaded from the wrong location. As I mentioned earlier a more lightweight parser may well be better suited, or perhaps using simple_xml to parse the feed manually. You will also see in the class contructor we switch the php error reporting and then back in the destructor. This is to stop issues with simplepie and E_STRICT mode on php5.

This code is very simple, and could be extended further. When we utilise the Newsfeeds module from magento, we will pass in parameters for the feed url, the number of items to display and an optional title. The initFeed() call will set up and retrieve the feed from the feedurl parameter configured within our static block (covered later on).  I have three main calls. These are initFeed() that will be called from the start of the Newsfeed template (listed later),  a call getFeedCount to get the number of feed items to display (or return a default of 5), and getFeedTitle that will return the title of the feed (or a pre configured title passed from the static block). The initFeed call has some code to configure the cache folder. The Mage::getConfig()->createDirIfNotExists($cache_dir); call is used to create a folder in the magento/var/cache folder called “newsfeeds”. This relies on the /var/cache folder being writable by the web server process. This however should already be setup correctly on your magento installation.

<?php

require_once('simplepie/idn/idna_convert.class.php');
require_once('simplepie/simplepie.class.php');

class Maglife_Newsfeeds_Block_View extends Mage_Core_Block_Template {

    public $_feed;
    private $_old_reporting;

    public function __construct()
    {
        // simplepie is made for php4 and will report errors in E_STRICT mode
        $this->_error_reporting = error_reporting( error_reporting() & ~ E_STRICT );
        $this->_feed = new SimplePie();
    }

    public function __destruct()
    {
        // restore error reporting to previous setting
        error_reporting($this->_old_reporting);
    }

    public function initFeed()
    {
        $this->_feed->set_feed_url($this->getfeedurl());
        $var_dir = Mage::getConfig()->getTempVarDir();
        $cache_dir = $var_dir . '/cache/newsfeeds';
        Mage::getConfig()->createDirIfNotExists($cache_dir);
        $this->_feed->set_cache_location($cache_dir);
        $this->_feed->init();
        $this->_feed->handle_content_type();
    }

    public function getFeedCount()
    {
        // if there is a count attribute for our block, use that,
        // alternatively, use a default
        if ( $this->getcount() ) {
            return $this->getcount();
        } else {
            return 5;
        }
    }

    public function getFeedTitle()
    {
        // if there is a title attribute for our block, use that for the
        // heading, alternatively, use the title of the news feed
        if ( $this->gettitle() ) {
            return $this->gettitle();
        } else {
            return $this->_feed->get_title();
        }

    }

}

Now for the template that controls the display/look of the newsfeeds block. You may well want to change this. The template lives in app/design/frontend/interfacename/theme/template/newsfeeds. For the default interface and theme that Magento ships with this would be app/design/frontend/default/default/template/newsfeeds. If you are using a custom theme you will want to create the newsfeeds folder in the relevent theme/templates folder. You are not forced to use this template file and folder name, but if you change them, make sure you reference the template correctly from the static block (shown later). The design and classes used in this template fit well with the Magento “blank” theme. The Magento blank theme is a simple theme that is a good starting point for creation of your own.

File: app/design/frontend/default/default/template/newsfeeds/view.phtml
A simple piece of html and php. The first line calls our initFeed() function that retrieves the feed. We then get the title, and loop through the feed items (displaying them in an unnumbered list). The $this->_feed object is a feed object returned by simplepie, so the code below for getting the items, is the same as you would find in the simplepie documentation.

<?php $this->initFeed() ?>
<div class="block block-newsfeeds">
    <div class="block-title">
        <h2><?php echo $this->getFeedTitle() ?></h2>
    </div>
    <div class="block-content">
        <ul>
        <?php foreach ($this->_feed->get_items(0, $this->getFeedCount()) as $item) { ?>
            <li>
                <a href="<?php echo $item->get_permalink(); ?>"><?php echo $item->get_title() ?></a>
            </li>
        <?php } ?>
        </ul>
    </div>
</div>

This is the last of the files for our module. The only thing left to do, is to activate the module within Magento, and then utilise our module within a static block. To enable our module we must make a small configuration file in app/etc/modules

File: app/etc/modules/Maglife_All.xml

<?xml version="1.0"?>
<config>
    <modules>
        <Maglife_Newsfeeds>
            <active>true</active>
            <codePool>local</codePool>
        </Maglife_Newsfeeds>
    </modules>
</config>

If you already have a Maglife_All.xml file (for example if you have used one of our earlier modules), then just add the <Maglife_Newsfeeds> section to the <modules> section of the xml.

Now, we are ready to try out the module.

Log into your Magento administration panel and navigate to the CMS/Static Blocks menu, and Add new Block. Enter the following information

  • Block Title: Newsfeeds
  • Identifier: newsfeeds
  • Store View: All Stores
  • Status: Enabled
  • Content: {{block type=”Maglife_Newsfeeds/View” template=”newsfeeds/view.phtml” feedurl=”http://news.google.com/news?ned=us&topic=h&output=atom” count=”5″}}

This tells Magento to use our custom block Maglife_Newsfeeds/View, with the template newsfeeds/view.phtml (or another template of your choice), along with the feedurl (for Google news – top stories). The count parameter is the number of items to display. There is also a title parameter that can be set to change the title in the displayed news block. If omitted as above it will use the title returned by the newsfeed.

Save this static block. We now want to make it display on the site. In this example we will make it display at the top right of the homepage. Navigate to CMS/Manage Pages on the administration panel and choose the Home page page that comes with the default magento install. Select the tab custom design. There should be a block of commented out XML. From here you can add layout XML to the homepage. Add the following XML to the bottom in the Layout Update XML textbox.

<reference name="right">
    <block type="cms/block" name="newsfeeds" before="-">
        <action method="setBlockId"><block_id>newsfeeds</block_id></action>
    </block>
</reference>

This tells Magento to display our static block at the top of the “right” section in the layout.

Now, hopefully, you should be able to navigate to your Magento home page and see a list of news items from Google news!

If you don’t I suggest turning on the debug logging from the Magento System/Configuration menu and checking for debug output  in var/logs/exception.log.

Please do let me know if you find any mistake/typos in this article. It is possible I may have forgotten a step or two. I hope this is of use to you, and at least gives some more ideas on how to work with Magento.