First commit

sites/all/modules/civicrm/CRM/Extension/Info.php

@@ -0,0 +1,183 @@
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | CiviCRM version 4.7                                                |
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC (c) 2004-2017                                |
+ +--------------------------------------------------------------------+
+ | This file is a part of CiviCRM.                                    |
+ |                                                                    |
+ | CiviCRM is free software; you can copy, modify, and distribute it  |
+ | under the terms of the GNU Affero General Public License           |
+ | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
+ |                                                                    |
+ | CiviCRM is distributed in the hope that it will be useful, but     |
+ | WITHOUT ANY WARRANTY; without even the implied warranty of         |
+ | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
+ | See the GNU Affero General Public License for more details.        |
+ |                                                                    |
+ | You should have received a copy of the GNU Affero General Public   |
+ | License and the CiviCRM Licensing Exception along                  |
+ | with this program; if not, contact CiviCRM LLC                     |
+ | at info[AT]civicrm[DOT]org. If you have questions about the        |
+ | GNU Affero General Public License or the licensing of CiviCRM,     |
+ | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ * Metadata for an extension (e.g. the extension's "info.xml" file)
+ *
+ * @package CRM
+ * @copyright CiviCRM LLC (c) 2004-2017
+ */
+class CRM_Extension_Info {
+
+  /**
+   * Extension info file name.
+   */
+  const FILENAME = 'info.xml';
+
+  public $key = NULL;
+  public $type = NULL;
+  public $name = NULL;
+  public $label = NULL;
+  public $file = NULL;
+
+  /**
+   * @var array
+   *   Each item is a specification like:
+   *   array('type'=>'psr4', 'namespace'=>'Foo\Bar', 'path'=>'/foo/bar').
+   */
+  public $classloader = array();
+
+  /**
+   * @var array
+   *   Each item is they key-name of an extension required by this extension.
+   */
+  public $requires = array();
+
+  /**
+   * Load extension info an XML file.
+   *
+   * @param $file
+   *
+   * @throws CRM_Extension_Exception_ParseException
+   * @return CRM_Extension_Info
+   */
+  public static function loadFromFile($file) {
+    list ($xml, $error) = CRM_Utils_XML::parseFile($file);
+    if ($xml === FALSE) {
+      throw new CRM_Extension_Exception_ParseException("Failed to parse info XML: $error");
+    }
+
+    $instance = new CRM_Extension_Info();
+    $instance->parse($xml);
+    return $instance;
+  }
+
+  /**
+   * Load extension info a string.
+   *
+   * @param string $string
+   *   XML content.
+   *
+   * @throws CRM_Extension_Exception_ParseException
+   * @return CRM_Extension_Info
+   */
+  public static function loadFromString($string) {
+    list ($xml, $error) = CRM_Utils_XML::parseString($string);
+    if ($xml === FALSE) {
+      throw new CRM_Extension_Exception_ParseException("Failed to parse info XML: $string");
+    }
+
+    $instance = new CRM_Extension_Info();
+    $instance->parse($xml);
+    return $instance;
+  }
+
+  /**
+   * Build a reverse-dependency map.
+   *
+   * @param array $infos
+   *   The universe of available extensions.
+   *   Ex: $infos['org.civicrm.foobar'] = new CRM_Extension_Info().
+   * @return array
+   *   If "org.civicrm.api" is required by "org.civicrm.foo", then return
+   *   array('org.civicrm.api' => array(CRM_Extension_Info[org.civicrm.foo])).
+   *   Array(string $key => array $requiredBys).
+   */
+  public static function buildReverseMap($infos) {
+    $revMap = array();
+    foreach ($infos as $info) {
+      foreach ($info->requires as $key) {
+        $revMap[$key][] = $info;
+      }
+    }
+    return $revMap;
+  }
+
+  /**
+   * @param null $key
+   * @param null $type
+   * @param null $name
+   * @param null $label
+   * @param null $file
+   */
+  public function __construct($key = NULL, $type = NULL, $name = NULL, $label = NULL, $file = NULL) {
+    $this->key = $key;
+    $this->type = $type;
+    $this->name = $name;
+    $this->label = $label;
+    $this->file = $file;
+  }
+
+  /**
+   * Copy attributes from an XML document to $this
+   *
+   * @param SimpleXMLElement $info
+   */
+  public function parse($info) {
+    $this->key = (string) $info->attributes()->key;
+    $this->type = (string) $info->attributes()->type;
+    $this->file = (string) $info->file;
+    $this->label = (string) $info->name;
+
+    // Convert first level variables to CRM_Core_Extension properties
+    // and deeper into arrays. An exception for URLS section, since
+    // we want them in special format.
+    foreach ($info as $attr => $val) {
+      if (count($val->children()) == 0) {
+        $this->$attr = (string) $val;
+      }
+      elseif ($attr === 'urls') {
+        $this->urls = array();
+        foreach ($val->url as $url) {
+          $urlAttr = (string) $url->attributes()->desc;
+          $this->urls[$urlAttr] = (string) $url;
+        }
+        ksort($this->urls);
+      }
+      elseif ($attr === 'classloader') {
+        $this->classloader = array();
+        foreach ($val->psr4 as $psr4) {
+          $this->classloader[] = array(
+            'type' => 'psr4',
+            'prefix' => (string) $psr4->attributes()->prefix,
+            'path' => (string) $psr4->attributes()->path,
+          );
+        }
+      }
+      elseif ($attr === 'requires') {
+        $this->requires = array();
+        foreach ($val->ext as $ext) {
+          $this->requires[] = (string) $ext;
+        }
+      }
+      else {
+        $this->$attr = CRM_Utils_XML::xmlObjToArray($val);
+      }
+    }
+  }
+
+}