Changeset 1917 for plugins/apostrophePlugin/trunk/lib/action/BaseaMediaActions.class.php

Timestamp:

08/08/10 12:18:34 (22 months ago)

Author:

tboutell

Message:

Merged the cropping branch back to trunk:

Cropping is now available in the media repository. Every time you select an image for use on the site you have the opportunity to crop it. The image size constraints of the slot are taken into account. This means that you can satisfy a given set of constraints by cropping a wide variety of images that would not have been eligible for selection before.

Crops of existing images appear in the database as separate aMediaItem objects but do not duplicate the original image file. This means that many crops of a single source image can exist without significant overhead.

The slug field of a cropped version of an image contains cropping parameters. When rendering the image, Symfony routes spot these and crop the original file as needed.

By approaching the problem this way we have avoided the need for code that takes advantage of the media repository's image selection capabilities to change in any way in order to take advantage of cropping.

The single-image-select behavior of Apostrophe has changed to accommodate the extra cropping step. Single select for PDFs and videos still uses the selectSingle partial because they cannot be cropped.

Thanks to Spike Broehm for his contributions to the cropping project.

Fixes #227

Location:

plugins/apostrophePlugin/trunk

Files:

• . (modified) (1 prop)
• lib/action/BaseaMediaActions.class.php (modified) (10 diffs)

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

@@ -31 +31 @@
         }
 
+  // Supported for backwards compatibility. See also 
+  // aMediaSelect::select()
+  
   public function executeSelect(sfRequest $request)
   {
@@ -45 +48 @@
       $selection = array($request->getParameter('aMediaId') + 0);
     } 
-    $items = aMediaItemTable::retrieveByIds($selection);
-    $ids = array();
-    foreach ($items as $item)
-    {
-      $ids[] = $item->getId();
-    }
     $options = array();
     $optional = array('type', 'aspect-width', 'aspect-height',
@@ -61 +58 @@
       }
     }
-    aMediaTools::setSelecting($after, $multiple, $ids, $options);
+    aMediaTools::setSelecting($after, $multiple, $selection, $options);
       
     return $this->redirect("aMedia/index");
@@ -113 +110 @@
     $aspectWidth = floor(aMediaTools::getAttribute('aspect-width'));
     $aspectHeight = floor(aMediaTools::getAttribute('aspect-height'));
-    // TODO: performance of these is not awesome (it's a linear search). 
-    // It would be more awesome with the right kind of indexing. For the 
-    // aspect ratio test to be more efficient we'd have to store the lowest 
-    // common denominator aspect ratio and index that.
-    if ($aspectWidth && $aspectHeight)
-    {
-      $params['aspect-width'] = $aspectWidth;
-      $params['aspect-height'] = $aspectHeight;
-    }
-
-    $minimumWidth = floor(aMediaTools::getAttribute('minimum-width'));
-    if ($minimumWidth)
-    {
+
+    if ($type === 'image')
+    {
+      // Now that we provide cropping tools, width and height should only exclude images
+      // that are too small to ever be cropped to that size
+      $minimumWidth = floor(aMediaTools::getAttribute('minimum-width'));
+      $width = floor(aMediaTools::getAttribute('width'));
+      $minimumWidth = max($minimumWidth, $width);
+      $minimumHeight = floor(aMediaTools::getAttribute('minimum-height'));
+      $height = floor(aMediaTools::getAttribute('height'));
+      $minimumHeight = max($minimumHeight, $height);
+      // Careful, aspect ratio can impose a bound on the other dimension
+      if ($minimumWidth && $aspectWidth)
+      {
+        $minimumHeight = max($minimumHeight, $minimumWidth * $aspectHeight / $aspectWidth);
+      }
+      if ($minimumHeight && $aspectHeight)
+      {
+        $minimumWidth = max($minimumWidth, $minimumHeight * $aspectWidth / $aspectHeight);
+      }
+      // We've updated these with implicit constraints from the aspect ratio, the width and height params, etc.
+      aMediaTools::setAttribute('minimum-width', $minimumWidth);
+      aMediaTools::setAttribute('minimum-height', $minimumHeight);
       $params['minimum-width'] = $minimumWidth;
-    }
-    $minimumHeight = floor(aMediaTools::getAttribute('minimum-height'));
-    if ($minimumHeight)
-    {
       $params['minimum-height'] = $minimumHeight;
     }
-    $width = floor(aMediaTools::getAttribute('width'));
-    if ($width)
-    {
-      $params['width'] = $width;
-    }
-    $height = floor(aMediaTools::getAttribute('height'));
-    if ($height)
-    {
-      $params['height'] = $height;
-    }
-
+    else
+    {
+      // TODO: performance of these is not awesome (it's a linear search). 
+      // It would be more awesome with the right kind of indexing. For the 
+      // aspect ratio test to be more efficient we'd have to store the lowest 
+      // common denominator aspect ratio and index that.
+      if ($aspectWidth && $aspectHeight)
+      {
+        $params['aspect-width'] = $aspectWidth;
+        $params['aspect-height'] = $aspectHeight;
+      }
+
+      $minimumWidth = floor(aMediaTools::getAttribute('minimum-width'));
+      if ($minimumWidth)
+      {
+        $params['minimum-width'] = $minimumWidth;
+      }
+      $minimumHeight = floor(aMediaTools::getAttribute('minimum-height'));
+      if ($minimumHeight)
+      {
+        $params['minimum-height'] = $minimumHeight;
+      }
+      $width = floor(aMediaTools::getAttribute('width'));
+      if ($width)
+      {
+        $params['width'] = $width;
+      }
+      $height = floor(aMediaTools::getAttribute('height'));
+      if ($height)
+      {
+        $params['height'] = $height;
+      }
+    }
+    
     // The media module is now an engine module. There is always a page, and that
     // page might have a restricted set of categories associated with it
@@ -162 +188 @@
     $this->pager->init();
     $this->results = $this->pager->getResults();
+
     aMediaTools::setSearchParameters(
       array("tag" => $tag, "type" => $type, 
@@ -175 +202 @@
         $this->label = aMediaTools::getAttribute("label");
       }
-      $this->limitSizes = false;
-      if ($aspectWidth || $aspectHeight || $minimumWidth || $minimumHeight ||
-        $width || $height)
-      {
-        $this->limitSizes = true;
-      }
+      $this->limitSizes = ($minimumWidth || $minimumHeight);
     }
   }
@@ -215 +237 @@
       $parameters));
   }
-
+  
+  // Accept and store cropping information for a particular image which must already be part of the selection
+  public function executeCrop(sfRequest $request)
+  {
+    $selection = aMediaTools::getSelection();
+    $id = $request->getParameter('id');
+    $index = array_search($id, $selection);
+    if ($index === false)
+    {
+      error_log("ID is $id and not found in index which is " . implode(',', $selection));
+      $this->forward404();
+    }
+    $cropLeft = floor($request->getParameter('cropLeft'));
+    $cropTop = floor($request->getParameter('cropTop'));
+    $cropWidth = floor($request->getParameter('cropWidth'));
+    $cropHeight = floor($request->getParameter('cropHeight'));
+    $width = floor($request->getParameter('width'));
+    $height = floor($request->getParameter('height'));
+    $imageInfo = aMediaTools::getAttribute('imageInfo');
+    $imageInfo[$id]['cropLeft'] = $cropLeft;
+    $imageInfo[$id]['cropTop'] = $cropTop;
+    $imageInfo[$id]['cropWidth'] = $cropWidth;
+    $imageInfo[$id]['cropHeight'] = $cropHeight;
+    $imageInfo[$id]['width'] = $width;
+    $imageInfo[$id]['height'] = $height;
+    aMediaTools::setAttribute('imageInfo', $imageInfo);
+  }
+  
   public function executeMultipleAdd(sfRequest $request)
   {
-    $this->forward404Unless(aMediaTools::isMultiple());
     $id = $request->getParameter('id') + 0;
     $item = Doctrine::getTable("aMediaItem")->find($id);
     $this->forward404Unless($item); 
     $selection = aMediaTools::getSelection();
-    $index = array_search($id, $selection);
-    // One occurrence each. If this changes we'll have to rethink
-    // the way reordering and deletion work (probably go by index).
-    if ($index === false)
-    {
-      $selection[] = $id;
+    if (!aMediaTools::isMultiple())
+    {
+      $selection = array($id);
+    }
+    else
+    {
+      $index = array_search($id, $selection);
+      // One occurrence each. If this changes we'll have to rethink
+      // the way reordering and deletion work (probably go by index).
+      if ($index === false)
+      {
+        $selection[] = $id;
+      }
     }
     aMediaTools::setSelection($selection);
+    $imageInfo = aMediaTools::getAttribute('imageInfo');
+    // Make no attempt to scrub out a previous crop, which could be handy
+    $imageInfo[$id]['width'] = $item->getWidth();
+    $imageInfo[$id]['height'] = $item->getHeight();
+    aMediaTools::setAttribute('imageInfo', $imageInfo);
+    // If no previous crop info is set, we must set an intial cropping mask
+    // so that the cropped media item id gets linked instead of the original
+    // media item. This is a little dangerous because JavaScript computes an
+    // intial crop mask on the client side.
+    aMediaTools::setDefaultCropDimensions($item);
+    if ((!aMediaTools::isMultiple()) && aMediaTools::getAttribute('type') !== 'image')
+    {
+      return $this->redirect('aMedia/selected');
+    }
     return $this->renderComponent("aMedia", "multipleList");
   }
@@ -236 +305 @@
   public function executeMultipleRemove(sfRequest $request)
   {
-    $this->forward404Unless(aMediaTools::isMultiple());
     $id = $request->getParameter('id');
     $item = Doctrine::getTable("aMediaItem")->find($id);
@@ -250 +318 @@
   }
 
+  public function executeUpdateMultiplePreview(sfRequest $request)
+  {
+    return $this->renderComponent('aMedia', 'multiplePreview');
+  }
+  
   public function executeMultipleOrder(sfRequest $request)
   {
     $this->logMessage("*****MULTIPLE ORDER", "info");
     $order = $request->getParameter('a-media-selection-list-item');
-    $oldSelection = aMediaTools::getSelection();
+    $oldSelection = aMediaTools::getSelection();    
     $keys = array_flip($oldSelection);
     $selection = array();
@@ -269 +342 @@
       $this->logMessage(">>>KEEPING " . $item->getId(), "info");
     }
-    $this->logMessage(">>>SUCCEEDED: " . implode(", ", $selection), "info");
+    $this->logMessage(">>>SUCCEEDED: " . implode(", ", $selection), "info");    
     aMediaTools::setSelection($selection);
     return $this->renderComponent("aMedia", "multipleList");
   }
+  
   public function executeSelected(sfRequest $request)
   {
-    $controller = $this->getController();
     $this->forward404Unless(aMediaTools::isSelecting());
-    if (aMediaTools::isMultiple())
-    {
-      $selection = aMediaTools::getSelection();
-      // Ooops best to get this before clearing it huh
-      $after = aMediaTools::getAfter();
-      // Oops I forgot to call this in the multiple case
+    $selection = aMediaTools::getSelection();
+    $imageInfo = aMediaTools::getAttribute('imageInfo');
+    // Get all the items in preparation for possible cropping
+    if (count($selection))
+    {
+      $items = Doctrine::getTable('aMediaItem')->createQuery('m')->whereIn('m.id', $selection)->execute();
+    }
+    else
+    {
+      $items = array();
+    }
+    $items = aArray::listToHashById($items);
+    $newSelection = array();
+    foreach ($selection as $id)
+    {
+      if (isset($imageInfo[$id]['cropLeft']))
+      {
+        // We need to make a crop
+        $item = $items[$id];
+        $crop = $item->findOrCreateCrop($imageInfo[$id]);
+        $crop->save();
+        $newSelection[] = $crop->id;
+      }
+      else
+      {
+        $newSelection[] = $id;
+      }
+    }
+    // Ooops best to get this before clearing it huh
+    $after = aMediaTools::getAfter();
+    
+    // addParamsNoDelete never attempts to eliminate a field just because
+    // its value is empty. This is how we distinguish between cancellation
+    // and selecting zero items
+    
+    if (!aMediaTools::isMultiple())
+    {
+      // Call this too soon and you lose isMultiple
       aMediaTools::clearSelecting();
-      // I thought about submitting this like a multiple select,
-      // but there's no clean way to implement that feature in
-      // addParam, and it wastes URL space anyway
-      // (remember the 1024-byte limit)
-      
-      // addParamsNoDelete never attempts to eliminate a field just because
-      // its value is empty. This is how we distinguish between cancellation
-      // and selecting zero items
-      return $this->redirect(
-        aUrl::addParamsNoDelete($after,
-        array("aMediaIds" => implode(",", $selection))));
-    }
-    // Single select
-    $id = $request->getParameter('id');
-    $item = Doctrine::getTable("aMediaItem")->find($id);
-    $this->forward404Unless($item); 
-    $after = aMediaTools::getAfter();
-    $after = aUrl::addParams($after, 
-      array("aMediaId" => $id));
-    aMediaTools::clearSelecting();
-    return $this->redirect($after);
+      if (count($newSelection))
+      {
+        $after = aUrl::addParams($after, 
+          array("aMediaId" => $newSelection[0]));
+        return $this->redirect($after);
+      }
+      else
+      {
+        $this->forward404();
+      }
+    }
+    else
+    {
+      aMediaTools::clearSelecting();
+      $url = aUrl::addParamsNoDelete($after,
+      array("aMediaIds" => implode(",", $newSelection)));
+      return $this->redirect($url);
+    }
   }