6 * Copyright 2011, Olivier Berger & Institut Telecom
8 * This program was developped in the frame of the COCLICO project
9 * (http://www.coclico-project.org/) with financial support of the Paris
12 * This file is part of FusionForge. FusionForge is free software;
13 * you can redistribute it and/or modify it under the terms of the
14 * GNU General Public License as published by the Free Software
15 * Foundation; either version 2 of the Licence, or (at your option)
18 * FusionForge is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License along
24 * with FusionForge; if not, write to the Free Software Foundation, Inc.,
25 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
28 require_once 'common/include/ProjectManager.class.php';
29 require_once 'common/include/rdfutils.php';
31 class doaprdfPlugin extends Plugin {
32 function __construct($id=0) {
33 parent::__construct($id) ;
34 $this->name = "doaprdf";
35 $this->text = _("DoaPRDF!"); // To show in the tabs, use...
37 _("This plugin provides DOAP RDF documents for projects on /projects URLs
38 with content-negotiation (application/rdf+xml).");
39 $this->_addHook("script_accepted_types");
40 $this->_addHook("content_negociated_project_home");
41 $this->_addHook("alt_representations");
46 * Declares itself as accepting RDF XML on /projects/...
47 * @param unknown_type $params
49 function script_accepted_types (&$params) {
50 $script = $params['script'];
51 if ($script == 'project_home') {
52 $params['accepted_types'][] = 'application/rdf+xml';
53 $params['accepted_types'][] = 'text/turtle';
57 function doapNameSpaces() {
58 // Construct an ARC2_Resource containing the project's RDF (DOAP) description
60 'rdf' => 'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
61 'rdfs' => 'http://www.w3.org/2000/01/rdf-schema#',
62 'doap' => 'http://usefulinc.com/ns/doap#',
63 'dcterms' => 'http://purl.org/dc/terms/'
68 function getProjectResourceIndex($group_id, &$ns, $detailed = false) {
70 // connect to FusionForge internals
71 $pm = ProjectManager::instance();
72 $project = $pm->getProject($group_id);
73 $projectname = $project->getUnixName();
74 $project_shortdesc = $project->getPublicName();
75 $project_description = $project->getDescription();
77 if (forge_get_config('use_project_tags')) {
78 $group = group_get_object($group_id);
79 $tags_list = $group->getTags();
86 $res = ARC2::getResource($conf);
87 $res->setURI(util_make_url_g($projectname, $group_id).'#project');
89 // $res->setRel('rdf:type', 'doap:Project');
90 rdfutils_setPropToUri($res, 'rdf:type', 'doap:Project');
92 $res->setProp('doap:name', $projectname);
93 $res->setProp('doap:shortdesc', $project_shortdesc);
94 if($project_description) {
95 $res->setProp('doap:description', $project_description);
97 $homepages = array(util_make_url_g($projectname, $group_id));
98 $project_homepage = $project->getHomePage();
99 if(!in_array($project_homepage, $homepages)) {
100 $homepages[] = $project_homepage;
102 $res->setProp('doap:homepage', $homepages);
105 $tags = split(', ',$tags_list);
106 $res->setProp('dcterms:subject', $tags);
109 // Now, we need to collect complementary RDF descriptiosn of the project via other plugins
110 // invoke the 'project_rdf_metadata' hook so as to complement the RDF description
111 $hook_params = array();
112 $hook_params['prefixes'] = array();
113 foreach($ns as $prefix => $url) {
114 $hook_params['prefixes'][$url] = $prefix;
116 $hook_params['group'] = $group_id;
117 // pass the resource in case it could be useful (read-only in principle)
118 $hook_params['in_Resource'] = $res;
119 $hook_params['out_Resources'] = array();
121 $hook_params['details'] = 'full';
124 $hook_params['details'] = 'minimal';
126 plugin_hook_by_reference('project_rdf_metadata', $hook_params);
128 // add new prefixes to the list
129 foreach($hook_params['prefixes'] as $url => $prefix) {
130 if (!isset($ns[$prefix])) {
135 // merge the two sets of triples
136 $merged_index = $res->index;
137 foreach($hook_params['out_Resources'] as $out_res) {
138 $merged_index = ARC2::getMergedIndex($merged_index, $out_res->index);
141 return $merged_index;
145 * Outputs project's DOAP profile
146 * @param unknown_type $params
148 function content_negociated_project_home (&$params) {
149 $projectname = $params['groupname'];
150 $accept = $params['accept'];
151 $group_id = $params['group_id'];
153 if($accept == 'application/rdf+xml' || $accept == 'text/turtle') {
155 // We will return RDF+XML
156 $params['content_type'] = $accept;
158 $ns = $this->doapNameSpaces();
160 $merged_index = $this->getProjectResourceIndex($group_id, $ns, $detailed = true);
164 'serializer_type_nodes' => true
167 if($accept == 'application/rdf+xml') {
168 $ser = ARC2::getRDFXMLSerializer($conf);
172 $ser = ARC2::getTurtleSerializer($conf);
174 /* Serialize a resource index */
175 $doc = $ser->getSerializedIndex($merged_index);
177 $params['content'] = $doc . "\n";
182 * Declares a link to itself in the link+meta HTML headers
183 * @param unknown_type $params
185 function alt_representations (&$params) {
186 $script_name = $params['script_name'];
187 $php_self = $params['php_self'];
188 // really trigger only for real projects descriptions, not for the projects index
189 if ( ($script_name == '/projects') && (($php_self != '/projects') && ($php_self != '/projects/')) ) {
190 $params['return'][] = '<link rel="alternate" type="application/rdf+xml" title="DOAP RDF Data" href=""/>';
191 $params['return'][] = '<link rel="alternate" type="test/turtle" title="DOAP RDF Data" href=""/>';
199 // c-file-style: "bsd"