Changes between Version 26 and Version 27 of faq/gitification

Timestamp:

Jun 9, 2012, 3:14:20 PM (13 years ago)

Author:

Bart

Comment:

Added git_subtree_system_info_alter()

faq/gitification

@@ -259 +259 @@
 
 One way to solve the problem would be a Drupal module which uses the [http://api.drush.ws/api/drush/docs!drush.api.php/5.x Drush api] to clone the git repository of each Drupal module locally and then determines the version information by using the ''git-subtree-split'' line returned by [http://git-scm.com/docs/git-log git-log]. It could write this information to a ''mymodule.gitinfo'' file. A module could then retrieve this information from the ''mymodule.gitinfo'' file and a [http://api.drupal.org/api/drupal/developer!hooks!core.php/function/hook_system_info_alter/6 hook_system_info_alter] could induce it into the local Drupal ecosystem. By adding {{{*.gitinfo}}} to [http://git-scm.com/book/en/Git-Basics-Recording-Changes-to-the-Repository ''.gitignore''] we could be sure that these files do not cause any problems when syncing with upstream repositories.
+
+=== git_subtree_system_info_alter() ===
+{{{
+/**
+ * Implement hook_system_info_alter() to provide metadata to drupal from git.
+ *
+ * We support populating $info from a gitinfo file.
+ *
+ * @param $info
+ *   The module/theme info array we're altering.
+ * @param $file
+ *   An object describing the filesystem location of the module/theme.
+ */
+function git_subtree_system_info_alter(&$info, $file) {
+  // Determine whether this is a theme or a module
+  $type = isset($info['engine']) ? 'theme' : 'module';
+  // We only need to look for a version if it is not yet set
+  if (empty($info['version'])) {
+    // Get the filename
+    $filename = check_plain($file->filename);
+    // Get the directory of the theme/module
+    $directory = dirname($filename);
+    // Check whether this belongs to core. Speed optimization.
+    if (drupal_substr($directory, 0, drupal_strlen($type)) != $type) {
+      // Guess the gitinfo filename
+      $gitinfo_filename = preg_replace('/\.[^.]*/', '.gitinfo', $filename);
+      // Check whether a gitinfo file exists
+      if (file_exists($gitinfo_filename) && is_readable ($gitinfo_filename)) {
+        // Parse the gitinfo file
+        $gitinfo = parse_ini_file($gitinfo_filename);
+        foreach (array_keys($gitinfo) as $key) {
+          if (isset($gitinfo[$key])) {
+            $info[$key] = $gitinfo[$key];
+          }
+        }
+      }
+    }
+  }
+}
+}}}