Changeset 20531

Timestamp:

07/27/09 21:18:24 (4 years ago)

Author:

boutell

Message:

Support for engines

Files:

• plugins/pkContextCMSPlugin/trunk/README (modified) (1 diff)
• plugins/pkContextCMSPlugin/trunk/UPGRADE (modified) (1 diff)
• plugins/pkContextCMSPlugin/trunk/config/doctrine/schema.yml (modified) (1 diff)
• plugins/pkContextCMSPlugin/trunk/lib/form/pkContextCMSPageSettingsForm.class.php (modified) (4 diffs)
• plugins/pkContextCMSPlugin/trunk/lib/model/doctrine/PluginpkContextCMSPage.class.php (modified) (1 diff)
• plugins/pkContextCMSPlugin/trunk/lib/model/doctrine/PluginpkContextCMSPageTable.class.php (modified) (1 diff)
• plugins/pkContextCMSPlugin/trunk/lib/pkContextCMSEngineActions.class.php (added)
• plugins/pkContextCMSPlugin/trunk/lib/pkContextCMSRoute.php (added)
• plugins/pkContextCMSPlugin/trunk/lib/pkContextCMSTools.php (modified) (5 diffs)
• plugins/pkContextCMSPlugin/trunk/modules/pkContextCMS/lib/BasepkContextCMSActions.class.php (modified) (2 diffs)
• plugins/pkContextCMSPlugin/trunk/modules/pkContextCMS/templates/settingsSuccess.php (modified) (2 diffs)

plugins/pkContextCMSPlugin/trunk/README

@@ -1291 +1291 @@
-*Note:* you should not add large numbers of buttons to the bar. Usually no more than one per plugin is advisable. It's important that the bar remain manageable and convenient for site admins.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

plugins/pkContextCMSPlugin/trunk/UPGRADE

@@ -1 +1 @@
-Upgrade Notes
+
+2009-07-27:
+
+ALTER TABLE pk_context_cms_page ADD COLUMN engine VARCHAR(255);
+
+This statement is necessary to accommodate the new "engine" feature, which greatly
+improves the extensibility of the CMS. Symfony modules can now be grafted into the
+page tree at any point, using normal actions and templates and otherwise-normal routes
+of the pkContextCMSRoute class. See README for details.
-
-2009-05-10:

plugins/pkContextCMSPlugin/trunk/config/doctrine/schema.yml

@@ -28 +28 @@
-    deleter_id:
-      type: integer(4)
+    engine:
+      type: string(255)
-  indexes:
-    slugindex:

plugins/pkContextCMSPlugin/trunk/lib/form/pkContextCMSPageSettingsForm.class.php

@@ -18 +18 @@
-      new sfWidgetFormSelect(
-        array('choices' => pkContextCMSTools::getTemplates())));
+     
+    $this->setWidget(
+      'engine',
+      new sfWidgetFormSelect(
+        array('choices' => pkContextCMSTools::getEngines())));
+
-    // On vs. off makes more sense to end users, but when we first
-    // designed this feature we had an 'archived vs. unarchived'
@@ -71 +77 @@
-          'choices' => array_keys(pkContextCMSTools::getTemplates()))));
-
+    // Making the empty string one of the choices doesn't seem to be good enough
+    // unless we expressly clear 'required'
+    $this->setValidator(
+      'engine',
+      new sfValidatorChoice(
+        array('required' => false,
+          'choices' => array_keys(pkContextCMSTools::getEngines()))));   
+
+
-    // The slug of the home page cannot change (chicken and egg problems)
-    if ($this->getObject()->getSlug() === '/')
@@ -135 +150 @@
-    $slug = preg_match("/^(\/.*?)\/*$/", $slug, $matches);
-    $object->slug = $matches[1];
-
+
+
+
+
+
-    $this->savePrivileges($object, 'edit', 'editors');
-    $this->savePrivileges($object, 'manage', 'managers');
+    // Has to be done on shutdown so it comes after the in-memory cache of
+    // sfFileCache copies itself back to disk, which otherwise overwrites
+    // our attempt to invalidate the routing cache [groan]
+    register_shutdown_function(array($this, 'invalidateRoutingCache'));
+  }
+  public function invalidateRoutingCache()
+  {
+    // Clear the routing cache on page settings changes. TODO:
+    // finesse this to happen only when the engine is changed,
+    // and then perhaps further to clear only cache entries
+    // relating to this page
+    $routing = sfContext::getInstance()->getRouting();
+    if ($routing)
+    {
+      $cache = $routing->getCache();
+      if ($cache)
+      {
+        sfContext::getInstance()->getLogger()->info("QZ got cache");
+        $cache->clean();
+        sfContext::getInstance()->getLogger()->info("QZ cleared cache");
+      }
+      else
+      {
+        sfContext::getInstance()->getLogger()->info("QZ no cache");
+      }
+    }
+    else
+    {
+      sfContext::getInstance()->getLogger()->info("QZ no routing");
+    }
-  }
-  protected function savePrivileges($object, $privilege, $widgetName)
@@ -149 +198 @@
-        $editorIds = array();
-      }
+      
-      $object->setAccessesById($privilege, $editorIds);
-    }

plugins/pkContextCMSPlugin/trunk/lib/model/doctrine/PluginpkContextCMSPage.class.php

@@ -461 +461 @@
-  }
-
-
-
-
+$absolute = true
+
+, $absolute
-  }
-

plugins/pkContextCMSPlugin/trunk/lib/model/doctrine/PluginpkContextCMSPageTable.class.php

@@ -218 +218 @@
-    return pkZendSearch::searchLuceneWithScores($this, $query, $culture);
-  }
+
+  // Returns engine page with the longest matching path.
+  // We use a cache so that we don't wind up making separate queries
+  // for every engine route in the application
+  
+  protected static $engineCacheUrl = false;
+  protected static $engineCachePage = false;
+  protected static $engineCacheRemainder = false;
+  
+  static public function getMatchingEnginePage($url, &$remainder)
+  {
+    if ($url === self::$engineCacheUrl)
+    {
+      $remainder = self::$engineCacheRemainder;
+      return self::$engineCachePage;
+    }
+    $urls = array();
+    $twig = $url;
+    while (true)
+    {
+      if (($twig === '/') || (!strlen($twig)))
+      {
+        // Either we've been called for the home page, or we just
+        // stripped the first slash and are now considering the home page
+        $urls[] = '/';
+        break;
+      }
+      $urls[] = $twig;
+      if (!preg_match('/^(.*)\/[^\/]+$/', $twig, $matches))
+      {
+        break;
+      }
+      $twig = $matches[1];
+    }
+    $page = Doctrine_Query::create()->
+      select('p.*, length(p.slug) as len')->
+      from('pkContextCMSPage p')->
+      whereIn('p.slug', $urls)->
+      andWhere('p.engine IS NOT NULL')->
+      orderBy('len desc')->
+      limit(1)->
+      fetchOne();
+    self::$engineCachePage = $page;
+    self::$engineCacheUrl = $url;
+    self::$engineCacheRemainder = false;
+    if ($page)
+    {
+      $remainder = substr($url, strlen($page->slug));
+      self::$engineCacheRemainder = $remainder;
+      return $page;
+    }
+    return false;
+  }
-}

plugins/pkContextCMSPlugin/trunk/lib/pkContextCMSTools.php

@@ -39 +39 @@
-    return $culture;
-  }
-
+, $absolute = true
-  {
-    // sfSimpleCMS found a nice workaround for this
@@ -45 +45 @@
-    // and not get tripped up by the default routing rule which could
-    // match first if we wrote pkContextCMS/show 
-tru
+$absolut
-    $routed_url = str_replace('-PLACEHOLDER-', $slug, $routed_url);
-    // We tend to get double slashes because slugs begin with slashes
-    // and the routing engine wants to helpfully add one too. Fix that,
-    // but don't break http://
-
+
+
+
+
+
+
+
+
-    return $routed_url;
-  }
@@ -162 +169 @@
-    return $options;
-  }
+  
-  static public function getTemplates()
-  {
@@ -174 +182 @@
-      'home' => 'Home Page'));
-  }
+  
+  static public function getEngines()
+  {
+    if (sfConfig::get('app_pkContextCMS_get_engines_method'))
+    {
+      $method = sfConfig::get('app_pkContextCMS_get_engines_method');
+
+      return call_user_func($method);
+    }
+    return sfConfig::get('app_pkContextCMS_engines', array(
+      '' => 'Template-Based'));
+  }
+  
-  // Fetch an internationalized option from app.yml. Example:
-  // all:
@@ -298 +319 @@
-    return self::$allowSlotEditing;
-  }
+  
+  // Kick the user out to appropriate places if they don't have the proper 
+  // privileges to be here. pkContextCMS::executeShow and pkContextCMSEngineActions::preExecute
+  // both use this 
+  
+  static public function validatePageAccess(sfAction $action, $page)
+  {
+    $action->forward404Unless($page);
+    if (!$page->userHasPrivilege('view'))
+    {
+      // forward rather than login because referrers don't always
+      // work. Hopefully the login action will capture the original
+      // URI to bring the user back here afterwards.
+
+      if ($action->getUser()->isAuthenticated())
+      {
+        return $action->forward(sfConfig::get('sf_secure_module'), sfConfig::get('sf_secure_action'));
+      }
+      else
+      {
+        return $action->forward(sfConfig::get('sf_login_module'), sfConfig::get('sf_login_action'));
+
+      }
+    }
+    if ($page->archived && (!$page->userHasPrivilege('edit|manage')))
+    {
+      $action->forward404();
+    }    
+  }
+
+  // Establish the page title, set the layout, and add the javascripts that are
+  // necessary to manage pages. pkContextCMS::executeShow and pkContextCMSEngineActions::preExecute
+  // both use this
+  
+  static public function setPageEnvironment(sfAction $action, pkContextCMSPage $page)
+  {
+    // Title is pre-escaped as valid HTML
+    $prefix = pkContextCMSTools::getOptionI18n('title_prefix');
+    $action->getResponse()->setTitle($prefix . $page->getTitle(), false);
+    // Necessary to allow the use of
+    // pkContextCMSTools::getCurrentPage() in the layout.
+    // In Symfony 1.1+, you can't see $action->page from
+    // the layout.
+    pkContextCMSTools::setCurrentPage($page);
+    // Borrowed from sfSimpleCMS
+    if(sfConfig::get('app_pkContextCMS_use_bundled_layout', true))
+    {
+      $action->setLayout(sfContext::getInstance()->getConfiguration()->getTemplateDir('pkContextCMS', 'layout.php').'/layout');
+    }
+
+    //JB 6.8.09 These are both necessary 100% of the time, so I added them here at this level.
+    $action->getResponse()->addJavascript('/pkToolkitPlugin/js/pkUI.js');
+    $action->getResponse()->addJavascript('/pkToolkitPlugin/js/pkControls.js');
+    $action->getResponse()->addJavascript('/pkToolkitPlugin/js/jquery.hotkeys-0.7.9.min.js'); // this is plugin for hotkey toggle for cms UI
+  }
-}

plugins/pkContextCMSPlugin/trunk/modules/pkContextCMS/lib/BasepkContextCMSActions.class.php

@@ -28 +28 @@
-    }
-    $page = pkContextCMSPageTable::retrieveBySlugWithSlots($slug);
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-    $this->page = $page;
-    // Necessary to allow the use of
-    // pkContextCMSTools::getCurrentPage() in the layout.
-    // In Symfony 1.1+, you can't see $this->page from
-    // the layout.
-    pkContextCMSTools::setCurrentPage($page);
-    $this->setTemplate($page->template);
-    // Borrowed from sfSimpleCMS
-    if(sfConfig::get('app_pkContextCMS_use_bundled_layout', true))
-    {
-      $this->setLayout(sfContext::getInstance()->getConfiguration()->getTemplateDir('pkContextCMS', 'layout.php').'/layout');
-    }
-
-    //JB 6.8.09 These are both necessary 100% of the time, so I added them here at this level.
-    $this->getResponse()->addJavascript('/pkToolkitPlugin/js/pkUI.js');
-    $this->getResponse()->addJavascript('/pkToolkitPlugin/js/pkControls.js');
-    $this->getResponse()->addJavascript('/pkToolkitPlugin/js/jquery.hotkeys-0.7.9.min.js'); // this is plugin for hotkey toggle for cms UI
-
-    return 'Template';
-  }
-
+
+  
-  // Note that these fetch based on the id or slug found in the
-  // named parameter of the request
@@ -385 +350 @@
-    }
-    $this->page = $this->retrievePageForEditingById($from);
+    
-    $this->form = new pkContextCMSPageSettingsForm($this->page);
-    if ($from === 'settings[id]')

plugins/pkContextCMSPlugin/trunk/modules/pkContextCMS/templates/settingsSuccess.php

@@ -31 +31 @@
-      <?php endif ?>
-      <div class="pk-form-row">
+        <label>Page Engine</label>
+        <?php echo $form['engine']->render(array('onClick' => 'pkUpdateEngineAndTemplate()')) ?>
+        <?php echo $form['engine']->renderError() ?>
+      </div>
+      <div class="pk-form-row" id="pk-page-template">
-        <label>Page Template</label>
-        <?php echo $form['template'] ?>
@@ -120 +125 @@
-<?php endif ?>
-  <script>
+  function pkUpdateEngineAndTemplate()
+  {
+    if (!$('#settings_engine').val().length)
+    {
+      $('#settings_template').show();
+    }
+    else
+    {
+      $('#settings_template').hide();
+    }
+  }
+  pkUpdateEngineAndTemplate();
-  <?php // you can do this: { remove: 'custom html for remove button' } ?>
-  pkMultipleSelect('#pk-page-settings', { });