diff options
| -rw-r--r-- | includes/common.inc | 97 | ||||
| -rw-r--r-- | modules/system/system.test | 71 |
2 files changed, 127 insertions, 41 deletions
diff --git a/includes/common.inc b/includes/common.inc index 51918f062..f2db46b28 100644 --- a/includes/common.inc +++ b/includes/common.inc @@ -5198,72 +5198,87 @@ function drupal_write_record($table, &$object, $primary_keys = array()) { */ /** - * Parse Drupal info file format. + * Parse Drupal module and theme info file format. * - * Files should use an ini-like format to specify values. - * White-space generally doesn't matter, except inside values. - * e.g. + * Info files are NOT for placing arbitrary theme and module-specific settings. + * Use variable_get() and variable_set() for that. * - * @verbatim + * Information stored in a module .info file: + * - name: The real name of the module for display purposes. + * - description: A brief description of the module. + * - dependencies: An array of shortnames of other modules this module requires. + * - package: The name of the package of modules this module belongs to. + * + * @see forum.info + * + * Information stored in a theme .info file: + * - name: The real name of the theme for display purposes + * - description: Brief description + * - screenshot: Path to screenshot relative to the theme's .info file. + * - engine: Theme engine, typically: engine = phptemplate + * - base: Name of a base theme, if applicable, eg: base = zen + * - regions: Listed regions eg: region[left] = Left sidebar + * - features: Features available eg: features[] = logo + * - stylesheets: Theme stylesheets eg: stylesheets[all][] = my-style.css + * - scripts: Theme scripts eg: scripts[] = my-script.css + * + * @see garland.info + * + * @param $filename + * The file we are parsing. Accepts file with relative or absolute path. + * @return + * The info array. + * + * @see drupal_parse_info_format() + */ +function drupal_parse_info_file($filename) { + if (!file_exists($filename)) { + return array(); + } + + $data = file_get_contents($filename); + return drupal_parse_info_format($data); +} + +/** + * Parse data in Drupal's .info format. + * + * Data should be in an .ini-like format to specify values. White-space + * generally doesn't matter, except inside values: + * @code * key = value * key = "value" * key = 'value' * key = "multi-line - * * value" * key = 'multi-line - * * value' * key * = * 'value' - * @endverbatim - * - * Arrays are created using a GET-like syntax: + * @endcode * - * @verbatim + * Arrays are created using a HTTP GET alike syntax: + * @code * key[] = "numeric array" * key[index] = "associative array" * key[index][] = "nested numeric array" * key[index][index] = "nested associative array" - * @endverbatim - * - * PHP constants are substituted in, but only when used as the entire value: + * @endcode * + * PHP constants are substituted in, but only when used as the entire value. * Comments should start with a semi-colon at the beginning of a line. * - * This function is NOT for placing arbitrary module-specific settings. Use - * variable_get() and variable_set() for that. - * - * Information stored in the module.info file: - * - name: The real name of the module for display purposes. - * - description: A brief description of the module. - * - dependencies: An array of shortnames of other modules this module requires. - * - package: The name of the package of modules this module belongs to. - * - * Example of .info file: - * @verbatim - * name = Forum - * description = Enables threaded discussions about general topics. - * dependencies[] = taxonomy - * dependencies[] = comment - * package = Core - * version = VERSION - * @endverbatim - * - * @param $filename - * The file we are parsing. Accepts file with relative or absolute path. + * @param $data + * A string to parse. * @return * The info array. + * + * @see drupal_parse_info_file() */ -function drupal_parse_info_file($filename) { +function drupal_parse_info_format($data) { $info = array(); - if (!file_exists($filename)) { - return $info; - } - - $data = file_get_contents($filename); if (preg_match_all(' @^\s* # Start at the beginning of a line, ignoring leading whitespace ((?: diff --git a/modules/system/system.test b/modules/system/system.test index e38658fa3..9df53b78f 100644 --- a/modules/system/system.test +++ b/modules/system/system.test @@ -1219,3 +1219,74 @@ class TokenReplaceTestCase extends DrupalWebTestCase { $this->assertFalse(strcmp($generated['[node:title]'], $node->title), t('Unsanitized token generated properly.')); } } + +class InfoFileParserTestCase extends DrupalUnitTestCase { + public static function getInfo() { + return array( + 'name' => 'Info file format parser', + 'description' => 'Tests proper parsing of a .info file formatted string.', + 'group' => 'System', + ); + } + + /** + * Test drupal_parse_info_format(). + */ + function testDrupalParseInfoFormat() { + $config = ' +simple = Value +quoted = " Value" +multiline = "Value + Value" +array[] = Value1 +array[] = Value2 +array_assoc[a] = Value1 +array_assoc[b] = Value2 +array_deep[][][] = Value +array_deep_assoc[a][b][c] = Value +array_space[a b] = Value'; + + $expected = array( + 'simple' => 'Value', + 'quoted' => ' Value', + 'multiline' => "Value\n Value", + 'array' => array( + 0 => 'Value1', + 1 => 'Value2', + ), + 'array_assoc' => array( + 'a' => 'Value1', + 'b' => 'Value2', + ), + 'array_deep' => array( + 0 => array( + 0 => array( + 0 => 'Value', + ), + ), + ), + 'array_deep_assoc' => array( + 'a' => array( + 'b' => array( + 'c' => 'Value', + ), + ), + ), + 'array_space' => array( + 'a b' => 'Value', + ), + ); + + $parsed = drupal_parse_info_format($config); + + $this->assertEqual($parsed['simple'], $expected['simple'], t('Set a simple value.')); + $this->assertEqual($parsed['quoted'], $expected['quoted'], t('Set a simple value in quotes.')); + $this->assertEqual($parsed['multiline'], $expected['multiline'], t('Set a multiline value.')); + $this->assertEqual($parsed['array'], $expected['array'], t('Set a simple array.')); + $this->assertEqual($parsed['array_assoc'], $expected['array_assoc'], t('Set an associative array.')); + $this->assertEqual($parsed['array_deep'], $expected['array_deep'], t('Set a nested array.')); + $this->assertEqual($parsed['array_deep_assoc'], $expected['array_deep_assoc'], t('Set a nested associative array.')); + $this->assertEqual($parsed['array_space'], $expected['array_space'], t('Set an array with a whitespace in the key.')); + $this->assertEqual($parsed, $expected, t('Entire parsed .info string and expected array are identical.')); + } +} |