GalleryPlugin.inc.php

<?php
 
define('PLUGIN_GALLERY_STATE_AVAILABLE', 0);
define('PLUGIN_GALLERY_STATE_INCOMPATIBLE', 0);
define('PLUGIN_GALLERY_STATE_UPGRADABLE', 1);
define('PLUGIN_GALLERY_STATE_CURRENT', 2);
define('PLUGIN_GALLERY_STATE_NEWER', 3);
 
class GalleryPlugin extends DataObject {
 
   function getLocalizedName($preferredLocale = null) {
      return $this->getLocalizedData('name', $preferredLocale);
   }
 
   function setName($name, $locale = null) {
      $this->setData('name', $name, $locale);
   }
 
   function getName($locale = null) {
      return $this->getData('name', $locale);
   }
 
   function getHomepage() {
      return $this->getData('homepage');
   }
 
   function setHomepage($homepage) {
      $this->setData('homepage', $homepage);
   }
 
   function getProduct() {
      return $this->getData('product');
   }
 
   function setProduct($product) {
      $this->setData('product', $product);
   }
 
   function getCategory() {
      return $this->getData('category');
   }
 
   function setCategory($category) {
      $this->setData('category', $category);
   }
 
   function getVersion($pad = false) {
      $version = $this->getData('version');
      if ($pad) {
         // Ensure there are 4 terms (3 separators)
         $separators = substr_count($version, '.');
         if ($separators<3) $version .= str_repeat('.0', 3-$separators);
      }
      return $version;
   }
 
   function setVersion($version) {
      $this->setData('version', $version);
   }
 
   function getDate() {
      return $this->getData('date');
   }
 
   function setDate($date) {
      $this->setData('date', $date);
   }
 
   function getContactName() {
      return $this->getData('contactName');
   }
 
   function setContactName($contactName) {
      $this->setData('contactName', $contactName);
   }
 
   function getContactInstitutionName() {
      return $this->getData('contactInstitutionName');
   }
 
   function setContactInstitutionName($contactInstitutionName) {
      $this->setData('contactInstitutionName', $contactInstitutionName);
   }
 
   function getContactEmail() {
      return $this->getData('contactEmail');
   }
 
   function setContactEmail($contactEmail) {
      $this->setData('contactEmail', $contactEmail);
   }
 
   function getSummary($locale = null) {
      return $this->getData('summary', $locale);
   }
 
   function setSummary($summary, $locale = null) {
      $this->setData('summary', $summary, $locale);
   }
 
   function getDescription($locale = null) {
      return $this->getData('description', $locale);
   }
 
   function setDescription($description, $locale = null) {
      $this->setData('description', $description, $locale);
   }
 
   function getInstallationInstructions($locale = null) {
      return $this->getData('installation', $locale);
   }
 
   function setInstallationInstructions($installation, $locale = null) {
      $this->setData('installation', $installation, $locale);
   }
 
   function getReleaseDescription($locale = null) {
      return $this->getData('releaseDescription', $locale);
   }
 
   function setReleaseDescription($releaseDescription, $locale = null) {
      $this->setData('releaseDescription', $releaseDescription, $locale);
   }
 
   function getReleaseMD5() {
      return $this->getData('releaseMD5');
   }
 
   function setReleaseMD5($releaseMD5) {
      $this->setData('releaseMD5', $releaseMD5);
   }
 
   function getReleaseCertifications() {
      return $this->getData('releaseCertifications');
   }
 
   function setReleaseCertifications($certifications) {
      $this->setData('releaseCertifications', $certifications);
   }
 
   function getReleasePackage() {
      return $this->getData('releasePackage');
   }
 
   function setReleasePackage($releasePackage) {
      $this->setData('releasePackage', $releasePackage);
   }
 
   function getLocalizedSummary() {
      return $this->getLocalizedData('summary');
   }
 
   function getLocalizedInstallationInstructions() {
      return $this->getLocalizedData('installation');
   }
 
   function getLocalizedDescription() {
      return $this->getLocalizedData('description');
   }
 
   function getLocalizedReleaseDescription() {
      return $this->getLocalizedData('releaseDescription');
   }
 
   function getInstalledVersion() {
      $versionDao = DAORegistry::getDAO('VersionDAO'); /* @var $versionDao VersionDAO */
      return $versionDao->getCurrentVersion('plugins.' . $this->getCategory(), $this->getProduct(), true);
   }
 
   function getCurrentStatus() {
      $installedVersion = $this->getInstalledVersion();
      if ($this->getVersion()===null) return PLUGIN_GALLERY_STATE_INCOMPATIBLE;
      if (!$installedVersion) return PLUGIN_GALLERY_STATE_AVAILABLE;
      if ($installedVersion->compare($this->getVersion(true))>0) return PLUGIN_GALLERY_STATE_NEWER;
      if ($installedVersion->compare($this->getVersion(true))<0) return PLUGIN_GALLERY_STATE_UPGRADABLE;
 
      $targetPath = Core::getBaseDir() . '/plugins/' . $this->getCategory() . '/' . $this->getProduct();
      if (!is_dir($targetPath)) return PLUGIN_GALLERY_STATE_UPGRADABLE;
 
      return PLUGIN_GALLERY_STATE_CURRENT;
   }
}