Changeset 11037

Timestamp:

06/27/07 09:44:12 (3 years ago)

Author:

rambo

Message:

Some sanity checking to the automatiuc request_switch generation
Basic feed outputs seem to work, now just to get the media tags
working properly (and calls to add_link_head to supported handler to
add the rel=alternate links)

Files:

• branches/MidCOM_2_8/org.routamc.photostream/handler/feed.php (modified) (4 diffs)
• branches/MidCOM_2_8/org.routamc.photostream/style/mangle_feed_data.php (added)
• branches/MidCOM_2_8/org.routamc.photostream/style/mangle_feed_item.php (added)
• branches/MidCOM_2_8/org.routamc.photostream/style/render_feed_item.php (added)
• branches/MidCOM_2_8/org.routamc.photostream/viewer.php (modified) (3 diffs)

branches/MidCOM_2_8/org.routamc.photostream/handler/feed.php

@@ -10 +10 @@
-class org_routamc_photostream_handler_feed extends org_routamc_photostream_handler_list
-{
+    var $_feed;
+
+    /**
+     * Array of normalized file basenames (with extension removed) pointing
+     * to de.bitfolge.feedcreator creator types
+     */
+    var $_supported_types = array
+    (
+        'rss' => 'RSS2.0',
+        'rss1' => 'RSS1.0',
+        'rss091' => 'RSS0.91',
+        'atom' => 'ATOM',
+    );
+
-    /**
-     * Simple default constructor.
@@ -19 +33 @@
-
-    /**
-Overloaded since we really dont' need those
+We override this to avoid unneccessary controller creations
-     */
-    function _prepare_ajax_controllers()
-    {
-
-
+
-    }
-
@@ -35 +48 @@
-    {
-        debug_push_class(__CLASS__, __FUNCTION__);
-
-
+
+
+
+
+
+
+
+
+
+
-        {
-            // Fatal, cannot solve haandler to use to get the actual data
-parent_handler_id
-
-
-
-parent_handler_id
+data['parent_handler_id']
+
+
+
+data['parent_handler_id']
-        debug_add("Resolved parent method to '{$parent_method}'");
+
+        if (!is_callable(array($this, $parent_method)))
+        {
+            // Fatal, parent method is not callable
+            debug_add("Handler method \$this->{$parent_method} is not callable", MIDCOM_LOG_ERROR);
+            debug_pop();
+            return false;
+        }
+        // Use array_pop so we can pass the args on to the parent handler and it will not get confused by too long argument list
+        $feed_type_arg = array_pop($args);
+
+        // This will also do some validations
+        $this->_normalize_feed_type($feed_type_arg);
+        $this->_resolve_feed_urls($args);
+        
+        debug_add("Calling \$this->{$parent_method}('{$data['parent_handler_id']}', \$args, \$data)");
+        if (!$this->$parent_method($data['parent_handler_id'], $args, $data))
+        {
+            debug_add("\$this->{$parent_method}('{$data['parent_handler_id']}', \$args, \$data) returned false", MIDCOM_LOG_ERROR);
+            debug_pop();
+            return false;
+        }
+        if (!isset($data['photos']))
+        {
+            debug_add("\$data['photos'] is not set, most probably we hit a method ('{$parent_method}') in the list handler that does not populate it", MIDCOM_LOG_WARN);
+            debug_pop();
+            return false;
+        }
+        $this->_create_feed();
+
-        // Now that we have all that we need, we can remove this reference from cluttering our world
-        unset($data['request_switch']);
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
-
-        debug_pop();
@@ -82 +111 @@
-    }
-
+    /**
+     * Reolves sane URL for both the HTML view and the feed
+     */
+    function _resolve_feed_urls($args)
+    {
+        $data =& $this->_request_data;
+        $data['prefix'] = $_MIDCOM->get_context_data(MIDCOM_CONTEXT_ANCHORPREFIX);
+        $parent_switch =& $data['request_switch'][$data['parent_handler_id']];
+        $data['list_url'] = $data['prefix'] . implode('/', $parent_switch['fixed_args']) . '/'. implode('/', $args) . '/';
+        $data['feed_url'] = "{$data['prefix']}feed/" . implode('/', $parent_switch['fixed_args']) . '/'. implode('/', $args) . "/{$data['feed_filename']}";
+    }
+
+    /**
+     * Resolves and sanity-checks the feed type from the filename given as last argument to the dispatcher
+     */
+    function _normalize_feed_type($type_str)
+    {
+        debug_push_class(__CLASS__, __FUNCTION__);
+        $data =& $this->_request_data;
+        $type = preg_replace('/\..*$/', '', strtolower($type_str));
+        debug_add("normalized '{$type_str}' to '{$type}'");
+        if (   !isset($this->_supported_types[$type])
+            || empty($this->_supported_types[$type]))
+        {
+            debug_add("Feed type '{$type}' is not supported", MIDCOM_LOG_ERROR);
+            debug_pop();
+            $_MIDCOM->generate_error(MIDCOM_ERRNOTFOUND, "Feed type '{$type}' is not supported");
+            // This will exit()
+        }
+        $data['feed_type'] = $this->_supported_types[$type];
+        $data['feed_filename'] = "{$type}.xml";
+    }
+
+    /**
+     * Instantiate the feed object and set base value
+     */
+    function _create_feed()
+    {
+        $data =& $this->_request_data;
+        $this->_feed = new UniversalFeedCreator();
+        $this->_feed->cssStyleSheet = false;
+        if (   isset($data['view_title'])
+            && !empty($data['view_title']))
+        {
+            $this->_feed->title = $data['view_title'];
+        }
+        else
+        {
+            $this->_feed->title = $this->_topic->extra;
+        }
+        $this->_feed->language = $this->_config->get('rss_language');
+        $this->_feed->editor = $this->_config->get('rss_webmaster');
+        $this->_feed->link = $data['list_url'];
+        $this->_feed->syndicationURL = $data['feed_url'];
+    }
+
+    /**
+     * Add each photo as item to the feed then creates the XML and
+     * finally calls an element if one wishes to mangle the raw feed data
+     */
-    function _show_dispatcher($handler_id, &$data)
-    {
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    }
-}

branches/MidCOM_2_8/org.routamc.photostream/viewer.php

@@ -348 +348 @@
-            }
-            $new_id = "feed:{$handler_id}";
+            if (isset($this->_request_switch[$new_id]))
+            {
+                debug_add("Not reating new switch '{$new_id}', it already exists", MIDCOM_LOG_INFO);
+                continue;
+            }
-            debug_add("Creating new switch with id '{$new_id}'");
-            // PHP5-TODO: Must be copy-by-value
@@ -360 +365 @@
-            $new_switch['variable_args']++;
-            
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-            // Add the new switch
-            debug_print_r("Setting \$this->_request_switch['{$new_id}'] to: ", $new_switch);
-            $this->_request_switch[$new_id] = $new_switch;
+
+            // If we were not forced to use the feed url space earlier add it anyway so we have at least one consistent interface
+            if ($new_switch['fixed_args'][0] !== 'feed')
+            {
+                array_unshift($new_switch['fixed_args'], 'feed');
+                $new_id = "feed2:{$handler_id}";
+                debug_print_r("Setting \$this->_request_switch['{$new_id}'] to: ", $new_switch);
+                $this->_request_switch[$new_id] = $new_switch;
+            }
+
-            unset($new_id, $new_switch);
-        }
@@ -373 +395 @@
-        debug_print_r('$this->_request_switch is now: ', $this->_request_switch);
-        debug_pop();
+    }
+
+    function _sanity_check_switch(&$new_switch)
+    {
+        debug_push_class(__CLASS__, __FUNCTION__);
+        foreach ($this->_request_switch as $handler_id => $switch_data)
+        {
+            debug_add("Comparing with handler '{$handler_id}'");
+            switch(true)
+            {
+                case (   !isset($switch_data['fixed_args'])
+                      && isset($new_switch['fixed_args'])):
+                    debug_add('existing switch has not-set fixed_args and new_switch has');
+                    $fixed_diff = true;
+                    break;
+                case (   !isset($new_switch['fixed_args'])
+                      && isset($switch_data['fixed_args'])):
+                    debug_add('new_switch has not-set fixed_args and existing switch has');
+                    $fixed_diff = true;
+                    break;
+                case (   !is_array($switch_data['fixed_args'])
+                      && is_array($new_switch['fixed_args'])):
+                    debug_add('existing switch fixed_args is not array, new_switch fixed_args is');
+                    $fixed_diff = true;
+                    break;
+                case (   !is_array($new_switch['fixed_args'])
+                      && is_array($switch_data['fixed_args'])):
+                    debug_add('new_switch fixed_args is not array, existing switch fixed_args is');
+                    $fixed_diff = true;
+                    break;
+                case (   is_array($switch_data['fixed_args'])
+                      && is_array($new_switch['fixed_args'])):
+                    debug_add('new_switch and existing switch fixed_args are both arrays, calling array_diff');
+                    $fixed_diff = array_diff($switch_data['fixed_args'], $new_switch['fixed_args']);
+                    if (empty($fixed_diff))
+                    {
+                        /**
+                         * array_diff() returns an array consisting of all elements in $array1 that are not in $array2,
+                         * NOT a true diff, thus we need to check again with reversed order
+                         */ 
+                        $fixed_diff = array_diff($new_switch['fixed_args'], $switch_data['fixed_args']);
+                    }
+                    break;
+                default:
+                    debug_add('defaulting fixed_diff to false');
+                    $fixed_diff = false;
+            }
+            debug_print_r('$fixed_diff: ', $fixed_diff);
+            if (!empty($fixed_diff))
+            {
+                // Fixed args differ
+                continue;
+            }
+            if (   !isset($switch_data['variable_args'])
+                || !isset($new_switch['variable_args'])
+                || $switch_data['variable_args'] < $new_switch['variable_args'])
+            {
+                // Variable args do not overlap
+                continue;
+            }
+            debug_add("handler '{$handler_id}' already implements the url space", MIDCOM_LOG_INFO);
+            debug_print_r('$new_switch was: ', $new_switch, MIDCOM_LOG_INFO);
+            debug_print_r("\$this->_request_switch['{$handler_id}'] was: ", $switch_data, MIDCOM_LOG_INFO);
+            debug_pop();
+            return false;
+        }
+        debug_pop();
+        return true;        
-    }
-