Changeset 2152

Timestamp:

09/08/10 15:56:27 (17 months ago)

Author:

tboutell

Message:

* The feed slot is now very, very tolerant. It accepts Twitter @usernames, partial URLs with  http:// missing, and URLs of plain old pages. If you provide the URL of a plain old page it examines that page and pulls out the first RSS feed URL referenced via a 'link' element.
* Automatic open of rich text editor when you add a rich text slot is back (this works for any slot that is correctly set up for it in the slot model class)
* Added the same feature to the RSS feed slot
* Refactored edit button JavaScript? into a.js
* The deprecated 'realSlug' property of slot components has been removed as planned. You should be using realUrl by now so your slots can be embedded in non-CMS pages

Location:

plugins/apostrophePlugin/trunk

Files:

• lib/action/BaseaSlotComponents.class.php (modified) (1 diff)
• lib/form/BaseaFeedForm.class.php (modified) (2 diffs)
• lib/model/doctrine/PluginaFeedSlot.class.php (modified) (1 diff)
• modules/a/templates/_area.php (modified) (1 diff)
• modules/a/templates/_simpleEditButton.php (modified) (1 diff)
• modules/a/templates/_slot.php (modified) (1 diff)
• web/js/a.js (modified) (3 diffs)

plugins/apostrophePlugin/trunk/lib/action/BaseaSlotComponents.class.php

@@ -17 +17 @@
     // TODO: remove this workaround in 1.5. All uses of actual_slug and real-slug need to go away
     // in favor of actual_url, we just don't want to break any old overrides in client projects.
-    $this->realSlug = aTools::getRealPage() ? aTools::getRealPage()->getSlug() : 'global';
+    
+    // Gone in 1.5
+    
+    // $this->realSlug = aTools::getRealPage() ? aTools::getRealPage()->getSlug() : 'global';
     
     $this->slot = $this->page->getSlot(

plugins/apostrophePlugin/trunk/lib/form/BaseaFeedForm.class.php

@@ -14 +14 @@
   {
     $this->setWidgets(array('url' => new sfWidgetFormInputText(array('label' => 'RSS Feed URL'))));
-    $this->setValidators(array('url' => new sfValidatorUrl(array('required' => true, 'max_length' => 1024))));
+  
+    // "And" is correct, these are really progressive filters improving the URL
+    
+    $this->setValidators(array('url' => new sfValidatorAnd(array(
+      // @foo => correct twitter RSS feed URL for that person (requires querying Twitter API)
+      new sfValidatorCallback(array('callback' => array($this, 'validateTwitterHandle'))), 
+      // www.foo.bar => http://www.foo.bar
+      new sfValidatorCallback(array('callback' => array($this, 'validateLazyUrl'))), 
+      // Must be a valid URL to go past this stage
+      new sfValidatorUrl(array('required' => true, 'max_length' => 1024)), 
+      // If the URL is a plain old page get the first RSS feed 'link'ed in it
+      new sfValidatorCallback(array('callback' => array($this, 'validateFeed')))))));
     
     // Ensures unique IDs throughout the page
@@ -22 +33 @@
     
   }
+  
+  // Convert Twitter handles to RSS feed URLs. Leave anything else alone
+  public function validateTwitterHandle($validator, $value)
+  {
+    if (preg_match('/^@(\w+)$/', $value, $matches))
+    {
+      $handle = $matches[1];
+      $info = json_decode(file_get_contents('http://api.twitter.com/1/users/show.json?' . http_build_query(array('screen_name' => $handle))), true);
+      if (isset($info['id']))
+      {
+        return 'http://twitter.com/statuses/user_timeline/' . $info['id'] . '.rss';
+      }
+    }
+    return $value;
+  }
+  
+  // If it smells like HTML and contains a suitable link tag, extract the first feed URL,
+  // which is probably what they meant. Otherwise leave it alone
+  public function validateFeed($validator, $value)
+  {
+    $content = @file_get_contents($value);
+    if ($content)
+    {
+      $html = new DOMDocument();
+      // Incredibly noisy on typical markup
+      @$html->loadHTML($content);
+      $xpath = new DOMXPath($html);
+      $arts = $xpath->query('//link[@rel="alternate" and @type="application/rss+xml"]');
+      if (isset($arts->length) && $arts->length)
+      {
+        return $arts->item(0)->getAttribute('href');
+      }
+    }
+    return $value;
+  }
+  // Add missing http://
+  public function validateLazyUrl($validator, $value)
+  {
+    if (preg_match('/^[\w\+-]+\./', $value))
+    {
+      return 'http://' . $value;
+    }
+    return $value;
+  }
 }

plugins/apostrophePlugin/trunk/lib/model/doctrine/PluginaFeedSlot.class.php

@@ -13 +13 @@
 abstract class PluginaFeedSlot extends BaseaFeedSlot
 {
+  protected $editDefault = true;
 }

plugins/apostrophePlugin/trunk/modules/a/templates/_area.php

@@ -88 +88 @@
           <?php // Make the slot aware of its permid for simpler JS later ?>
           <?php a_js_call('$(?).data(?, ?)', "#a-slot-$pageid-$name-$permid", 'a-permid', $permid) ?>
+                
                 <?php // Slot Controls ?>
     <?php if ($editable): ?>

plugins/apostrophePlugin/trunk/modules/a/templates/_simpleEditButton.php

@@ -23 +23 @@
 
   <li>
-  <?php echo jq_link_to_function(isset($label) ? __($label, null, 'apostrophe') : __("edit", null, 'apostrophe'), "", 
+  <?php // We want to eliminate jQuery helpers, but writing this link as raw HTML is tricky because ?>
+  <?php // of the need to quote the title option right. And link_to doesn't like '#' as a URL. So we use ?>
+  <?php // content_tag, Symfony's lower-level helper for outputting any tag and its content programmatically ?>
+  <?php echo content_tag('a', isset($label) ? a_($label) : a_("edit"), 
                         array(
+                          'href' => '#',
                                 'id' => "a-slot-edit-$pageid-$name-$permid",
                                 'class' => isset($class) ? $class : 'a-btn icon a-edit', 
-                                'title' => isset($title) ? $title : __('Edit', null, 'apostrophe'), 
+                                'title' => isset($title) ? $title : a_('Edit'), 
   )) ?>
 
-  <script type="text/javascript" charset="utf-8">
-  <?php // TODO: Rewrite this as a button class scoped to ALL edit buttons so there's only a single instance of this Javascript ?>
-        $(document).ready(function() {
-          <?php // This is now AJAX code to load the edit view on demand ?>
-                var editBtn = $('#a-slot-edit-<?php echo "$pageid-$name-$permid" ?>');
-                var editSlot = $('#a-slot-<?php echo "$pageid-$name-$permid" ?>');
-                editBtn.click(function(event){
-                  if (!editSlot.children('.a-slot-content').children('.a-slot-form').length)
-                  {
-                  $.get(<?php echo json_encode(url_for($slot->type . 'Slot/ajaxEditView') . '?' . http_build_query(array('id' => $pageid, 'slot' => $name, 'permid' => $permid))) ?>, { }, function(data) { 
-                      editSlot.children('.a-slot-content').html(data);
-                      apostrophe.slotShowEditView(editBtn, editSlot);
-                    });
-                  }
-                  else
-                  {
-                    // Reuse edit view
-                      apostrophe.slotShowEditView(editBtn, editSlot);
-                  }
-                  return false;
-                });
-        });
-  </script>
+  <?php a_js_call('apostrophe.slotEnableEditButton(?, ?, ?, ?)', $pageid, $name, $permid, url_for($slot->type . 'Slot/ajaxEditView')) ?>
   </li>
         

plugins/apostrophePlugin/trunk/modules/a/templates/_slot.php

@@ -22 +22 @@
 <?php // considerable overhead of loading many instances of FCK we won't use ?>
 
-<?php if ($editable && $updating): ?>
+<?php if ($editable && ($updating || $showEditor)): ?>
   <form method="POST" action="#" class="a-slot-form a-edit-view clearfix" name="a-slot-form-<?php echo $id ?>" id="a-slot-form-<?php echo $id ?>" style="display: <?php echo $showEditor ? "block" : "none" ?>">
 

plugins/apostrophePlugin/trunk/web/js/a.js

@@ -464 +464 @@
         }
         
-        // This is just the beginning of bigger refactoring needed in this area
-        this.slotShowEditView = function(editBtn, editSlot)
-        {
-                editBtn.parents('.a-slot, .a-area').addClass('editing-now'); // Apply a class to the Area and Slot Being Edited
-                editSlot.children('.a-slot-content').children('.a-slot-content-container').hide(); // Hide the Content Container
-                editSlot.children('.a-slot-content').children('.a-slot-form').fadeIn(); // Fade In the Edit Form
-                editSlot.children('.a-control li.variant').hide(); // Hide the Variant Options
-                aUI(editBtn.parents('.a-slot').attr('id')); // Refresh the UI scoped to this Slot
+        this.slotShowEditView = function(pageid, name, permid)
+        {       
+                var fullId = pageid + '-' + name + '-' + permid;
+                var editSlot = $('#a-slot-' + fullId);
+          if (!editSlot.children('.a-slot-content').children('.a-slot-form').length)
+          {
+                  $.get(editSlot.data('a-edit-url'), { id: pageid, slot: name, permid: permid }, function(data) { 
+              editSlot.children('.a-slot-content').html(data);
+              slotShowEditViewPreloaded(pageid, name, permid);
+            });
+          }
+          else
+          {
+            // Reuse edit view
+      slotShowEditViewPreloaded(pageid, name, permid);
+          }
         }
         
@@ -506 +514 @@
         }
         
+        this.slotEnableEditButton = function(pageid, name, permid, editUrl)
+        {
+                var fullId = pageid + '-' + name + '-' + permid;
+                var editBtn = $('#a-slot-edit-' + fullId);
+                var editSlot = $('#a-slot-' + fullId);
+                editSlot.data('a-edit-url', editUrl);
+                editBtn.click(function(event) {
+                        apostrophe.slotShowEditView(pageid, name, permid);
+                  return false;
+                });
+  }
+
         // Private methods callable only from the above (no this.foo = bar)
         function slotUpdateMoveButtons(id, name, slot, n, slots, updateAction)
@@ -539 +559 @@
                 }
         }
+        
+        function slotShowEditViewPreloaded(pageid, name, permid)
+        {
+                var fullId = pageid + '-' + name + '-' + permid;
+                var editBtn = $('#a-slot-edit-' + fullId);
+                var editSlot = $('#a-slot-' + fullId);
+                
+                editBtn.parents('.a-slot, .a-area').addClass('editing-now'); // Apply a class to the Area and Slot Being Edited
+                editSlot.children('.a-slot-content').children('.a-slot-content-container').hide(); // Hide the Content Container
+                editSlot.children('.a-slot-content').children('.a-slot-form').fadeIn(); // Fade In the Edit Form
+                editSlot.children('.a-control li.variant').hide(); // Hide the Variant Options
+                aUI(editBtn.parents('.a-slot').attr('id')); // Refresh the UI scoped to this Slot
+        }
 }