=== added directory 'modules/rdf' === added file 'modules/rdf/rdf.api.php' --- modules/rdf/rdf.api.php 1970-01-01 00:00:00 +0000 +++ modules/rdf/rdf.api.php 2009-10-03 17:25:00 +0000 @@ -0,0 +1,47 @@ + array( + 'rdftype' => array('sioc:Post'), + 'title' => array('dc:title'), + 'created' => array( + 'property' => array('dc:date', 'dc:created'), + 'datatype' => 'xsd:dateTime', + 'callback' => 'date_iso8601', + ), + 'name' => array('foaf:name'), + 'uid' => array('sioc:has_creator', 'foaf:maker'), + ) + ); +} + +/** + * @} End of "addtogroup hooks". + */ === added file 'modules/rdf/rdf.crud.inc' --- modules/rdf/rdf.crud.inc 1970-01-01 00:00:00 +0000 +++ modules/rdf/rdf.crud.inc 2009-10-03 17:25:00 +0000 @@ -0,0 +1,87 @@ + $type, + 'bundle' => $bundle, + 'mapping' => serialize($mapping) + ); + + db_insert('rdf_mapping')->fields($fields)->execute(); + + return $mapping; +} + +/** + * Read an RDF mapping record directly from the database. + * + * @param $type + * The entity type the mapping refers to. + * @param $bundle + * The bundle the mapping refers to. + * @return array + * An RDF mapping structure or FALSE if the mapping could not be found. + */ +function rdf_read_mapping($type, $bundle) { + $query = db_select('rdf_mapping')->fields(NULL, array('mapping')) + ->condition('type', $type)->condition('bundle', $bundle)->execute(); + + return unserialize($query->fetchField()); +} + +/** + * Update an RDF mapping binded to a bundle and an entity type. + * + * @param $type + * The entity type the mapping refers to. + * @param $bundle + * The bundle the mapping refers to. + * @param $mapping + * An associative array representing an RDF mapping structure. The required + * keys and values are + * type: The entity type the mapping refers to. + * bundle: The bundle the mapping refers to. + * mapping: An array describing the mapping of this bundle/entity. + * @return bool + */ +function rdf_update_mapping($type, $bundle, $mapping) { + $fields = array('mapping' => serialize($mapping)); + $num_rows = db_update('rdf_mapping')->fields($fields) + ->condition('type', $type)->condition('bundle', $bundle)->execute(); + + return ($num_rows > 0); +} + +/** + * Delete the mapping for the given pair of type and bundle from the database. + * + * @param $type + * The entity type the mapping refers to. + * @param $bundle + * The bundle the mapping refers to. + * @return bool + */ +function rdf_delete_mapping($type, $bundle) { + $num_rows = db_delete('rdf_mapping')->condition('type', $type) + ->condition('bundle', $bundle)->execute(); + + return ($num_rows > 0); +} === added file 'modules/rdf/rdf.info' --- modules/rdf/rdf.info 1970-01-01 00:00:00 +0000 +++ modules/rdf/rdf.info 2009-10-03 17:25:00 +0000 @@ -0,0 +1,10 @@ +; $Id$ +name = RDF +description = Allows to map the site data structure to RDF and export it in RDFa. +package = Core +version = VERSION +core = 7.x +files[] = rdf.install +files[] = rdf.module +files[] = rdf.crud.inc +files[] = rdf.test === added file 'modules/rdf/rdf.install' --- modules/rdf/rdf.install 1970-01-01 00:00:00 +0000 +++ modules/rdf/rdf.install 2009-10-03 17:25:00 +0000 @@ -0,0 +1,40 @@ + 'Stores custom RDF mappings for user defined content types or overriden module-defined mappings', + 'fields' => array( + 'type' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => TRUE, + 'description' => 'The name of the entity type a mapping applies to (node, user, comment, etc.).', + ), + 'bundle' => array( + 'type' => 'varchar', + 'length' => 128, + 'not null' => TRUE, + 'description' => 'The name of the bundle a mapping applies to.', + ), + 'mapping' => array( + 'description' => 'The serialized mapping of the bundle type and fields to RDF terms.', + 'type' => 'text', + 'not null' => FALSE, + 'size' => 'big', + 'serialize' => TRUE, + ), + ), + 'primary key' => array('type', 'bundle'), + ); + + return $schema; +} === added file 'modules/rdf/rdf.module' --- modules/rdf/rdf.module 1970-01-01 00:00:00 +0000 +++ modules/rdf/rdf.module 2009-10-07 15:37:03 +0000 @@ -0,0 +1,333 @@ + array( + * 'rdftype' => array('sioct:Post'), + * 'title' => array( + * 'property' => array('dc:title'), + * ), + * 'created' => array( + * 'property' => array('dc:date', 'dc:created'), + * 'datatype' => 'xsd:dateTime', + * 'callback' => 'date_iso8601', + * ), + * 'replyof' => array( + * 'property' => array('sioc:reply_of'), + * ), + * 'name' => array( + * 'property' => array('dc:creator'), + * ), + * ) + * ); + */ + +/* + * Load all public RDF CRUD API functions. Drupal currently has no + * mechanism for auto-loading core APIs, so we have to load them on + * every page request. + */ +require(DRUPAL_ROOT . '/modules/rdf/rdf.crud.inc'); + +/** + * Returns the mapping for the attributes of the given bundle. + * + * @param $type + * An entity type. + * @param $bundle + * A bundle name. + * @return array + * The mapping corresponding to the requested type, bundle combo. + */ +function rdf_get_mapping($type, $bundle) { + // Retrieve the mapping from the entity info. + $entity_info = entity_get_info($type); + return !empty($entity_info['bundles'][$bundle]['rdf_mapping']) ? $entity_info['bundles'][$bundle]['rdf_mapping'] : NULL; +} + +/** + * Saves an RDF mapping to the database. + * + * Takes a mapping structure returned by hook_rdf_mapping() implementations + * and creates or updates a record mapping for each encountered + * type, bundle pair. If available, adds default values for non-existent + * mapping keys. + * + * @param $mapping + * The RDF mapping to save, as an array. + * @return + * Status flag indicating the outcome of the operation. + */ +function rdf_save_mapping($mapping) { + // Adds default values for non-existent keys. + $new_mapping = $mapping['mapping'] + _rdf_get_default_mapping($mapping['type']); + $exists = (bool)rdf_read_mapping($mapping['type'], $mapping['bundle']); + + if ($exists) { + rdf_update_mapping($mapping['type'], $mapping['bundle'], $new_mapping); + return SAVED_UPDATED; + } + else { + rdf_create_mapping($mapping['type'], $mapping['bundle'], $new_mapping); + return SAVED_NEW; + } + + cache_clear_all('entity_info', 'cache'); + drupal_static_reset('entity_get_info'); +} + +/** + * Implements hook_modules_installed(). + * + * Checks if the installed modules have any RDF mapping definitions to declare + * and stores them in the rdf_mapping table. + */ +function rdf_modules_installed($modules) { + // We need to clear the caches of entity_info as this is not done right + // during the tests. see http://drupal.org/node/594234 + cache_clear_all('entity_info', 'cache'); + drupal_static_reset('entity_get_info'); + + foreach ($modules as $module) { + if (function_exists($module . '_rdf_mapping')) { + $mapping_array = call_user_func($module . '_rdf_mapping'); + foreach ($mapping_array as $mapping) { + rdf_save_mapping($mapping); + } + } + } +} + +/** + * Implements hook_modules_uninstalled(). + */ +function rdf_modules_uninstalled($modules) { +// TODO remove the RDF mappings. +} + +/** + * Implements hook_entity_info_alter(). + * + * Adds the proper RDF mapping to each entity type, bundle pair. + */ +function rdf_entity_info_alter(&$entity_info) { + // Loop through each entity type and its bundles. + foreach ($entity_info as $entity_type => $entity_type_info) { + if (isset($entity_type_info['bundles'])) { + foreach ($entity_type_info['bundles'] as $bundle => $bundle_info) { + if ($mapping = rdf_read_mapping($entity_type, $bundle)) { + $entity_info[$entity_type]['bundles'][$bundle]['rdf_mapping'] = $mapping; + } + else { + // If no mapping was found in the database, assign the default RDF + // mapping for this entity type. + $entity_info[$entity_type]['bundles'][$bundle]['rdf_mapping'] = _rdf_get_default_mapping($entity_type); + } + } + } + } +} + +/** + * Returns ready to render RDFa attributes for the given mapping. + * + * @param $mapping + * An array containing a mandatory property key and optional datatype and + * callback keys. + * Example: + * array( + * 'property' => array('dc:created'), + * 'datatype' => 'xsd:dateTime', + * 'callback' => 'date_iso8601', + * ) + * @param $data + * A value that needs to be converted by the provided callback function. + * @return array + * An array containing RDFa attributes ready for rendering. + */ +function drupal_rdfa_attributes($mapping, $data = NULL) { + $attributes['property'] = $mapping['property']; + + if (isset($mapping['callback']) && isset($data)) { + $callback = $mapping['callback']; + + if (function_exists($callback)) { + $attributes['content'] = call_user_func($callback, $data); + } + if (isset($mapping['datatype'])) { + $attributes['datatype'] = $mapping['datatype']; + } + } + + return $attributes; +} + +/** + * Implements hook_node_load(). + */ +function rdf_node_load($nodes, $types) { + foreach ($nodes as $node) { + $node->rdf_mapping = rdf_get_mapping('node', $node->type); + // The node_load function does not reuse user_load(), so we need to + // regenerate the URI of the author of the node. + $node->rdf['user'] = array('uri' => _rdf_generate_user_uri($node->uid)); + } +} + +/** + * Implements hook_user_load(). + */ +function rdf_user_load($users) { + // Generate an RDF resource URI for each user account. + foreach ($users as $user) { + $user->rdf = array('uri' => _rdf_generate_user_uri($user->uid)); + } +} + +/** + * Implements hook_comment_view(). + * + * @param $comments + * An array of comment objects. + */ +function rdf_comment_view($comment){ + $comment->rdf_mapping = rdf_get_mapping('comment', $comment->node_type); +} + +/** + * Helper function to create a URI for the user object. + * + * @param $uid + * The user id the URI should be generated from. + * @return + * A URI including the base path of the site, e.g. '/subdomain/user/1#user'. + */ +function _rdf_generate_user_uri($uid) { + return base_path() . 'user/' . $uid . '#user'; +} + +/** + * Returns an ISO8601 formatted date based on the given date. + * + * Can be used as a callback for mappings. + * + * @param $date + * A unix timestamp. + * @return string + * An ISO8601 formatted date. + */ +function date_iso8601($date) { + return date(DATE_ISO8601, $date); +} + +/** + * Implements MODULE_preprocess_HOOK(). + */ +function rdf_preprocess_node(&$variables) { + // Add RDFa markup to the node container. The about attribute specifies the + // URI of the resource described within the HTML element, while the typeof + // attribute indicates its RDF type (foaf:Document, or sioc:User, etc.). + $variables['attributes_array']['about'] = empty($variables['node_url']) ? NULL: $variables['node_url']; + $variables['attributes_array']['typeof'] = empty($variables['node']->rdf_mapping['rdftype']) ? NULL : $variables['node']->rdf_mapping['rdftype']; + + // Add RDFa markup to the title of the node. Because the RDFa markup is added + // to the h2 tag which might contain HTML code, we specify an empty datatype + // to ensure the value of the title read by the RDFa parsers is a literal. + $variables['title_attributes_array']['property'] = empty($variables['node']->rdf_mapping['title']['property']) ? NULL : $variables['node']->rdf_mapping['title']['property']; + $variables['title_attributes_array']['datatype'] = ''; + + // In full node mode, the title is not displayed by node.tpl.php so it is + // added in the head tag of the HTML page. + if ($variables['page']) { + $title_attributes['property'] = empty($variables['node']->rdf_mapping['title']['property']) ? NULL : $variables['node']->rdf_mapping['title']['property']; + $title_attributes['content'] = $variables['title']; + drupal_add_html_head(''); + } + + // Add RDFa markup for the date. + // TODO use a theme_timestamp() function instead? see http://drupal.org/node/574954 + if (!empty($variables['rdf_mapping']['created'])) { + $date_attributes_array = drupal_rdfa_attributes($variables['rdf_mapping']['created'], $variables['created']); + $variables['date'] = '' . $variables['date'] . ''; + } +} + +/** + * Adds RDFa attributes to the template variables. + * + * @param $variables + */ +function rdf_preprocess_field(&$variables) { + $entity_type = $variables['element']['#object_type']; + $instance = $variables['instance']; + $mapping = rdf_get_mapping($entity_type, $instance['bundle']); + $field_name = $instance['field_name']; + + if (!empty($mapping) && !empty($mapping[$field_name])) { + foreach ($variables['items'] as $delta => $item) { + $variables['item_attributes_array'][$delta] = drupal_rdfa_attributes($mapping[$field_name], $item['#item']); + } + } +} + +/** + * Implements MODULE_preprocess_HOOK(). + */ +function rdf_preprocess_username(&$variables) { + if (!empty($variables['object']->account->rdf_mapping['name'])) { + if (isset($variables['object']->link_path)) { + $variables['object']->link_attributes['rel'] = $variables['object']->account->rdf_mapping['uid']['property']; + } + else { + $variables['object']->attributes['property'] = $variables['object']->account->rdf_mapping['name']['property']; + } + } +} + +/** + * Implements MODULE_preprocess_HOOK(). + */ +function rdf_preprocess_comment(&$variables) { + if (!empty($variables['comment']->rdf_mapping['rdftype'])) { + $variables['attributes_array']['typeof'] = $variables['comment']->rdf_mapping['rdftype']; + } + if (!empty($variables['comment']->rdf_mapping['title'])) { + $variables['title_attributes_array']['property'] = $variables['comment']->rdf_mapping['title']['property']; + $variables['title_attributes_array']['datatype'] = ''; + } + if (!empty($variables['comment']->rdf_mapping['created'])) { + $date_attributes_array = drupal_rdfa_attributes($variables['comment']->rdf_mapping['created'], $variables['comment']->timestamp); + $variables['date'] = '' . $variables['date'] . ''; + } +} + +/** + * Returns the default RDFa mapping for the given entity type. + * + * @param $type + * An entity type. + * @return array + * The RDFa mappings or an empty array. + */ +function _rdf_get_default_mapping($type) { + $default_mappings = array(); + $function = "{$type}_rdf_mapping_defaults"; + + if (function_exists($function)) { + $default_mappings = call_user_func($function); + } + + return $default_mappings; +} === added file 'modules/rdf/rdf.test' --- modules/rdf/rdf.test 1970-01-01 00:00:00 +0000 +++ modules/rdf/rdf.test 2009-10-07 16:13:49 +0000 @@ -0,0 +1,180 @@ + t('RDF mapping hook'), + 'description' => t('Test hook_rdf_mapping().'), + 'group' => t('RDF'), + ); + } + + function setUp() { + parent::setUp('rdf', 'rdf_test', 'field_test'); + // We need to trigger rdf_modules_installed() because + // hook_modules_installed() is not automatically invoked during testing. + rdf_modules_installed(array('rdf_test')); + } + + /** + * Test that the mappings are correctly returned and processed by the hook_rdf_mapping(). + */ + function testMapping() { + // Test that the mapping is returned correctly by the hook. + $mapping = rdf_get_mapping('test_entity', 'test_bundle'); + $this->assertIdentical($mapping['rdftype'], array('sioc:Post'), t('Mapping for rdftype is sioc:Post.')); + $this->assertIdentical($mapping['title'], array('property' => array('dc:title')), t('Mapping for title is dc:title.')); + $this->assertIdentical($mapping['created'], array( + 'property' => array('dc:created'), + 'datatype' => 'xsd:dateTime', + 'callback' => 'date_iso8601', + ), t('Mapping for created is dc:created with datatype xsd:dateTime and callback date_iso8601.')); + $this->assertIdentical($mapping['uid'], array('property' => array('sioc:has_creator', 'dc:creator')), t('Mapping for uid is sioc:has_creator and dc:creator.')); + + // Test that NULL is returned when an entity type, bundle pair has no mapping. + $mapping = rdf_get_mapping('test_entity', 'test_bundle_no_mapping'); + $this->assertTrue($mapping === NULL, t('NULL returned when an entity type, bundle pair has no mapping.')); + } +} + +class RdfMarkupTestCase extends DrupalWebTestCase { + public static function getInfo() { + return array( + 'name' => t('RDFa markup'), + 'description' => t('Test RDFa markup generation.'), + 'group' => t('RDF'), + ); + } + + function setUp() { + parent::setUp('rdf', 'field_test', 'rdf_test'); + rdf_modules_installed(array('field_test', 'rdf_test')); + } + + /** + * Test drupal_rdfa_attributes(). + */ + function testDrupalRdfaAtributes() { + $date = 1252750327; + $isoDate = date(DATE_ISO8601, $date); + + $expected_type = 'xsd:dateTime'; + $expected_property = array('dc:created'); + $expected_value = $isoDate; + + $mapping = rdf_get_mapping('test_entity', 'test_bundle'); + $attributes = drupal_rdfa_attributes($mapping['created'], $date); + + $this->assertEqual($expected_type, $attributes['datatype']); + $this->assertEqual($expected_property, $attributes['property']); + $this->assertEqual($expected_value, $attributes['content']); + } + +} + +class RdfCrudTestCase extends DrupalWebTestCase { + public static function getInfo() { + return array( + 'name' => 'RDF mapping CRUD functions', + 'description' => 'Test the RDF mapping CRUD functions.', + 'group' => 'RDF', + ); + } + + function setUp() { + parent::setUp('rdf', 'rdf_test'); + } + + function testCreateReadUpdateWrite() { + $test_mapping = rdf_test_rdf_mapping(); + + $this->assertFalse(rdf_read_mapping('test_entity', 'test_bundle')); + $this->assertEqual( + rdf_create_mapping('test_entity', 'test_bundle', $test_mapping[0]['mapping']), + $test_mapping[0]['mapping'] + ); + + try { + rdf_create_mapping('test_entity', 'test_bundle', $test_mapping[0]['mapping']); + $this->fail('No Exception thrown when attempting to insert the same mapping another time.'); + } + catch (Exception $e) { + $this->pass('Exception thrown when attempting to insert the same mapping another time.'); + } + + $this->assertEqual($test_mapping[0]['mapping'], + rdf_read_mapping('test_entity', 'test_bundle')); + $this->assertTrue(rdf_update_mapping('test_entity', 'test_bundle', + $test_mapping[1]['mapping'])); + $this->assertEqual($test_mapping[1]['mapping'], + rdf_read_mapping('test_entity', 'test_bundle')); + $this->assertTrue(rdf_delete_mapping('test_entity', 'test_bundle')); + $this->assertFalse(rdf_read_mapping('test_entity', 'test_bundle')); + } + + function testSaveMapping() { + $test_mapping = rdf_test_rdf_mapping(); + rdf_save_mapping($test_mapping[0]); + + $this->assertEqual($test_mapping[0]['mapping'], + rdf_read_mapping('test_entity', 'test_bundle')); + } + +} + +class RdfMappingDefinitionTestCase extends DrupalWebTestCase { + public static function getInfo() { + return array( + 'name' => t('RDF mapping definition functionnality'), + 'description' => t('Test the different types of RDF mappings and ensure the proper RDFa markup in included in node pages.'), + 'group' => t('RDF'), + ); + } + + function setUp() { + parent::setUp('rdf', 'rdf_test', 'blog'); + // We need to trigger rdf_modules_installed() because + // hook_modules_installed() is not automatically invoked during testing. + rdf_modules_installed(array('rdf_test')); + // entity_info caches must be cleared during testing. This is done + // automatically during the manual installation. + cache_clear_all('entity_info', 'cache'); + drupal_static_reset('entity_get_info'); + } + + /** + * Create a node of type blog and test whether the RDF mapping defined for + * this node type in rdf_test.module is used in the node page. + */ + function testAttributesInMarkup1() { + $node = $this->drupalCreateNode(array('type' => 'blog')); + $this->drupalGet('node/' . $node->nid); + + $this->assertRaw('typeof="sioct:Weblog"'); + } + + /** + * Create a content type and a node of type test_bundle_hook_install and test + * whether the RDF mapping defined in rdf_test.install is used. + */ + function testAttributesInMarkup2() { + $type = $this->drupalCreateContentType(array('type' => 'test_bundle_hook_install')); + $node = $this->drupalCreateNode(array('type' => 'test_bundle_hook_install')); + $this->drupalGet('node/' . $node->nid); + + $this->assertRaw('typeof="foo:mapping_install1 bar:mapping_install2"'); + } + + /** + * Create a random content type and node and ensure the default mapping for + * node is used. + */ + function testAttributesInMarkup3() { + $type = $this->drupalCreateContentType(); + $node = $this->drupalCreateNode(array('type' => $type->type)); + $this->drupalGet('node/' . $node->nid); + + $this->assertRaw('typeof="sioc:Item foaf:Document"'); + } +} === added directory 'modules/rdf/tests' === added file 'modules/rdf/tests/rdf_test.info' --- modules/rdf/tests/rdf_test.info 1970-01-01 00:00:00 +0000 +++ modules/rdf/tests/rdf_test.info 2009-10-07 12:51:57 +0000 @@ -0,0 +1,9 @@ +; $Id$ +name = "RDF module tests" +description = "Support module for RDF module testing." +package = Testing +version = VERSION +core = 7.x +files[] = rdf_test.install +files[] = rdf_test.module +hidden = TRUE === added file 'modules/rdf/tests/rdf_test.install' --- modules/rdf/tests/rdf_test.install 1970-01-01 00:00:00 +0000 +++ modules/rdf/tests/rdf_test.install 2009-10-07 12:57:21 +0000 @@ -0,0 +1,26 @@ + 'node', + 'bundle' => 'test_bundle_hook_install', + 'mapping' => array( + 'rdftype' => array('foo:mapping_install1', 'bar:mapping_install2'), + ), + ), + ); + + foreach ($rdf_mappings as $rdf_mapping) { + rdf_save_mapping($rdf_mapping); + } +} \ No newline at end of file === added file 'modules/rdf/tests/rdf_test.module' --- modules/rdf/tests/rdf_test.module 1970-01-01 00:00:00 +0000 +++ modules/rdf/tests/rdf_test.module 2009-10-07 15:44:16 +0000 @@ -0,0 +1,44 @@ + array( + 'type' => 'test_entity', + 'bundle' => 'test_bundle', + 'mapping' => array( + 'rdftype' => array('sioc:Post'), + 'title' => array( + 'property' => array('dc:title'), + ), + 'created' => array( + 'property' => array('dc:created'), + 'datatype' => 'xsd:dateTime', + 'callback' => 'date_iso8601', + ), + 'uid' => array( + 'property' => array('sioc:has_creator', 'dc:creator'), + ), + 'foobar' => array( + 'property' => array('foo:bar'), + ), + ), + ), + 1 => array( + 'type' => 'node', + 'bundle' => 'blog', + 'mapping' => array( + 'rdftype' => array('sioct:Weblog'), + ) + ), + ); +} === modified file 'profiles/default/default.install' --- profiles/default/default.install 2009-10-01 13:22:43 +0000 +++ profiles/default/default.install 2009-10-03 17:25:00 +0000 @@ -146,6 +146,28 @@ function default_install() { node_type_save($type); } + // Insert default user-defined RDF mapping into the database. + $rdf_mappings = array( + array( + 'type' => 'node', + 'bundle' => 'page', + 'mapping' => array( + 'rdftype' => array('foaf:Document'), + ), + ), + array( + 'type' => 'node', + 'bundle' => 'article', + 'mapping' => array( + 'rdftype' => array('sioc:Item', 'foaf:Document'), + ), + ), + ); + + foreach ($rdf_mappings as $rdf_mapping) { + rdf_save_mapping($rdf_mapping); + } + // Default page to not be promoted and have comments disabled. variable_set('node_options_page', array('status')); variable_set('comment_page', COMMENT_NODE_HIDDEN);