f-prot isn't so open now, so might aswell not advertise it in DefaultSetttings under...
[lhc/web/wiklou.git] / includes / Metadata.php
index c8253c4..229856d 100644 (file)
 <?php
-/* Metadata.php -- provides DublinCore and CreativeCommons metadata
+/**
+ * Base code to format metadata.
+ *
  * Copyright 2004, Evan Prodromou <evan@wikitravel.org>.
- * 
- *  This program is free software; you can redistribute it and/or modify
- *  it under the terms of the GNU General Public License as published by
- *  the Free Software Foundation; either version 2 of the License, or
- *  (at your option) any later version.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
  *
  * This program 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 General Public License for more details.
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
  *
- *  You should have received a copy of the GNU General Public License
- *  along with this program; if not, write to the Free Software
- *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @author Evan Prodromou <evan@wikitravel.org>
+ * @file
  */
 
-define("RDF_TYPE_PREFS", "application/rdf+xml,text/xml;q=0.7,application/xml;q=0.5,text/rdf;q=0.1");
-                        
-function wfDublinCoreRdf($article) {
-       
-       $url = dcReallyFullUrl($article->mTitle);
-       
-       if (rdfSetup()) {
-               dcPrologue($url);
-               dcBasics($article);
-               dcEpilogue();
+abstract class RdfMetaData {
+       const RDF_TYPE_PREFS = 'application/rdf+xml,text/xml;q=0.7,application/xml;q=0.5,text/rdf;q=0.1';
+
+       /**
+        * Constructor
+        * @param $article Article object
+        */
+       public function __construct( Page $article ) {
+               $this->mArticle = $article;
        }
-}
 
-function wfCreativeCommonsRdf($article) {
-       
-       if (rdfSetup()) {
-               global $wgRightsUrl;
-               
-               $url = dcReallyFullUrl($article->mTitle);
-               
-               ccPrologue();
-               ccSubPrologue('Work', $url);
-               dcBasics($article);
-               if (isset($wgRightsUrl)) {
-                       $url = htmlspecialchars( $wgRightsUrl );
-                       print "    <cc:license rdf:resource=\"$url\" />\n";
-               }
-               
-               ccSubEpilogue('Work');
-               
-               if (isset($wgRightsUrl)) {
-                       $terms = ccGetTerms($wgRightsUrl);
-                       if ($terms) {
-                               ccSubPrologue('License', $wgRightsUrl);
-                               ccLicense($terms);
-                               ccSubEpilogue('License');
-                       }
+       public abstract function show();
+
+       protected function setup() {
+               global $wgOut, $wgRequest;
+
+               $httpaccept = isset( $_SERVER['HTTP_ACCEPT'] ) ? $_SERVER['HTTP_ACCEPT'] : null;
+               $rdftype = wfNegotiateType( wfAcceptToPrefs( $httpaccept ), wfAcceptToPrefs( self::RDF_TYPE_PREFS ) );
+
+               if( !$rdftype ){
+                       throw new HttpError( 406, wfMessage( 'notacceptable' ) );
                }
-       }
-       
-       ccEpilogue();
-}
 
-/* private */ function rdfSetup() {
-       global $wgOut, $wgRdfMimeType, $_SERVER;
-       
-       $rdftype = wfNegotiateType(wfAcceptToPrefs($_SERVER['HTTP_ACCEPT']), wfAcceptToPrefs(RDF_TYPE_PREFS));
-       
-       if (!$rdftype) {
-               wfHttpError(406, "Not Acceptable", wfMsg("notacceptable"));
-               return false;
-       } else {
                $wgOut->disable();
-               header( "Content-type: {$rdftype}" );
+               $wgRequest->response()->header( "Content-type: {$rdftype}; charset=utf-8" );
                $wgOut->sendCacheControl();
                return true;
        }
-}
-
-/* private */ function dcPrologue($url) {
-       global $wgOutputEncoding;
-       
-       $url = htmlspecialchars( $url );
-       print "<" . "?xml version=\"1.0\" encoding=\"{$wgOutputEncoding}\" ?" . ">
-                       
-<!DOCTYPE rdf:RDF PUBLIC \"-//DUBLIN CORE//DCMES DTD 2002/07/31//EN\" \"http://dublincore.org/documents/2002/07/31/dcmes-xml/dcmes-xml-dtd.dtd\">
-                       
-<rdf:RDF xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"
-         xmlns:dc=\"http://purl.org/dc/elements/1.1/\">
-  <rdf:Description rdf:about=\"$url\">
-";
-}
 
-/* private */ function dcEpilogue() {
-       print "
-  </rdf:Description>
-</rdf:RDF>
-";
-}
-
-/* private */ function dcBasics($article) {
-       global $wgLanguageCode, $wgSitename;
-       
-       dcElement('title', $article->mTitle->getText());
-       dcPageOrString('publisher', wfMsg('aboutpage'), $wgSitename);
-       dcElement('language', $wgLanguageCode);
-       dcElement('type', 'Text');
-       dcElement('format', 'text/html');
-       dcElement('identifier', dcReallyFullUrl($article->mTitle));
-       dcElement('date', dcDate($article->getTimestamp()));
-       dcPerson('creator', $article->getUser());
-       
-       $contributors = dcContributors($article);
-       
-       foreach ($contributors as $user_name => $cid) {
-               dcPerson('contributor', $cid, $user_name);
+       protected function reallyFullUrl() {
+               return $this->mArticle->getTitle()->getFullURL();
        }
-       
-       dcRights($article);
-}
 
-/* private */ function ccPrologue() {
-       global $wgOutputEncoding;
-       
-       echo "<" . "?xml version='1.0'  encoding='{$wgOutputEncoding}' ?" . ">
-          
-<rdf:RDF xmlns:cc=\"http://web.resource.org/cc/\"
-         xmlns:dc=\"http://purl.org/dc/elements/1.1/\"
-         xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\">
-";
-}  
+       protected function basics() {
+               global $wgLanguageCode, $wgSitename;
 
-/* private */ function ccSubPrologue($type, $url) {
-       $url = htmlspecialchars( $url );
-       echo "  <cc:{$type} rdf:about=\"{$url}\">\n";
-}  
+               $this->element( 'title', $this->mArticle->getTitle()->getText() );
+               $this->pageOrString( 'publisher', wfMsg( 'aboutpage' ), $wgSitename );
+               $this->element( 'language', $wgLanguageCode );
+               $this->element( 'type', 'Text' );
+               $this->element( 'format', 'text/html' );
+               $this->element( 'identifier', $this->reallyFullUrl() );
+               $this->element( 'date', $this->date( $this->mArticle->getTimestamp() ) );
 
-/* private */ function ccSubEpilogue($type) {
-       echo "  </cc:{$type}>\n";
-}  
+               $lastEditor = User::newFromId( $this->mArticle->getUser() );
+               $this->person( 'creator', $lastEditor );
 
-/* private */ function ccLicense($terms) {
-       
-       foreach ($terms as $term) {
-               switch ($term) {
-               case 're':
-                       ccTerm('permits', "Reproduction"); break;
-               case 'di':
-                       ccTerm('permits', "Distribution"); break;
-               case 'de':
-                       ccTerm('permits', "DerivativeWorks"); break;
-               case 'nc':
-                       ccTerm('prohibits', "CommercialUse"); break;
-               case 'no':
-                       ccTerm('requires', "Notice"); break;
-               case 'by':
-                       ccTerm('requires', "Attribution"); break;
-               case 'sa':
-                       ccTerm('requires', "ShareAlike"); break;
-               case 'sc':
-                       ccTerm('requires', "SourceCode"); break;                
+               foreach( $this->mArticle->getContributors() as $user ){
+                       $this->person( 'contributor', $user );
                }
-       }
-}
-
-/* private */ function ccTerm($term, $name) {
-       print "    <cc:{$term} rdf:resource=\"http://web.resource.org/cc/{$name}\" />\n";
-}
 
-/* private */ function ccEpilogue() {
-       echo "</rdf:RDF>\n";
-}
-
-/* private */ function dcElement($name, $value) {
-       $value = htmlspecialchars( $value );
-       print "    <dc:{$name}>{$value}</dc:{$name}>\n";
-}
-
-/* private */ function dcDate($timestamp) {
-       return substr($timestamp, 0, 4) . "-" 
-               . substr($timestamp, 4, 2) . "-" 
-               . substr($timestamp, 6, 2);
-}
-
-/* private */ function dcReallyFullUrl($title) {
-       return $title->getFullURL();
-}
-
-/* private */ function dcPageOrString($name, $page, $str) {
-       $nt = Title::newFromText($page);
-       
-       if (!$nt || $nt->getArticleID() == 0) {
-               dcElement($name, $str);
-       } else {
-               dcPage($name, $nt);
+               $this->rights();
        }
-}
 
-/* private */ function dcPage($name, $title) {
-       dcUrl($name, dcReallyFullUrl($title));
-}
+       protected function element( $name, $value ) {
+               $value = htmlspecialchars( $value );
+               print "\t\t<dc:{$name}>{$value}</dc:{$name}>\n";
+       }
 
-/* private */ function dcUrl($name, $url) {
-       $url = htmlspecialchars( $url );
-       print "    <dc:{$name} rdf:resource=\"{$url}\" />\n";
-}
+       protected function date($timestamp) {
+               return substr($timestamp, 0, 4) . '-'
+                 . substr($timestamp, 4, 2) . '-'
+                 . substr($timestamp, 6, 2);
+       }
 
-/* private */ function dcPerson($name, $id, $user_name="") {
-       global $wgLang;
+       protected function pageOrString( $name, $page, $str ) {
+               if( $page instanceof Title ) {
+                       $nt = $page;
+               } else {
+                       $nt = Title::newFromText( $page );
+               }
 
-       if ($id == 0) {
-               dcElement($name, wfMsg("anonymous"));
-       } else {
-               if( empty( $user_name ) ) {
-                       $user_name = User::whoIs($id);
+               if( !$nt || $nt->getArticleID() == 0 ){
+                       $this->element( $name, $str );
+               } else {
+                       $this->page( $name, $nt );
                }
-               dcPageOrString($name, $wgLang->getNsText(NS_USER) . ":" . $user_name, $user_name);
        }
-}
-
-/* private */ function dcContributors($article) {
-
-        $title = $article->mTitle;
-
-       $contribs = array();
-       
-       $res = wfQuery("SELECT DISTINCT old_user,old_user_text" .
-                      " FROM old " .
-                      " WHERE old_namespace = " . $title->getNamespace() .
-                      " AND old_title = '" . $title->getDBkey() . "'" .
-                       " AND old_user != 0 " .
-                       " AND old_user != " . $article->getUser(), DB_READ);
-       
-       while ( $line = wfFetchObject( $res ) ) {
-               $contribs[$line->old_user_text] = $line->old_user;
-       }    
 
-        # Count anonymous users
-
-       $res = wfQuery("SELECT COUNT(*) AS cnt " .
-                      " FROM old " .
-                      " WHERE old_namespace = " . $title->getNamespace() .
-                      " AND old_title = '" . $title->getDBkey() . "'" .
-                       " AND old_user = 0 ", DB_READ);
-
-       while ( $line = wfFetchObject( $res ) ) {
-                $contribs[$line->cnt] = 0;
-       }    
+       /**
+        * @param $name string
+        * @param $title Title
+        */
+       protected function page( $name, $title ) {
+               $this->url( $name, $title->getFullUrl() );
+       }
 
-       return $contribs;
-}
+       protected function url($name, $url) {
+               $url = htmlspecialchars( $url );
+               print "\t\t<dc:{$name} rdf:resource=\"{$url}\" />\n";
+       }
 
-/* Takes an arg, for future enhancement with different rights for
- different pages. */
+       protected function person( $name, User $user ) {
+               if( $user->isAnon() ){
+                       $this->element( $name, wfMsgExt( 'anonymous', array( 'parsemag' ), 1 ) );
+               } else {
+                       $real = $user->getRealName();
+                       if( $real ) {
+                               $this->element( $name, $real );
+                       } else {
+                               $userName = $user->getName();
+                               $this->pageOrString( $name, $user->getUserPage(), wfMsgExt( 'siteuser', 'parsemag', $userName, $userName ) );
+                       }
+               }
+       }
 
-/* private */ function dcRights($article) {
-       
-       global $wgRightsPage, $wgRightsUrl, $wgRightsText;
-       
-       if (isset($wgRightsPage) &&
-               ($nt = Title::newFromText($wgRightsPage))
-               && ($nt->getArticleID() != 0)) {
-               dcPage('rights', $nt);
-       } else if (isset($wgRightsUrl)) {
-               dcUrl('rights', $wgRightsUrl);
-       } else if (isset($wgRightsText)) {
-               dcElement('rights', $wgRightsText);
+       /**
+        * Takes an arg, for future enhancement with different rights for
+        * different pages.
+        */
+       protected function rights() {
+               global $wgRightsPage, $wgRightsUrl, $wgRightsText;
+
+               if( $wgRightsPage && ( $nt = Title::newFromText( $wgRightsPage ) )
+                       && ($nt->getArticleID() != 0)) {
+                       $this->page('rights', $nt);
+               } elseif( $wgRightsUrl ){
+                       $this->url('rights', $wgRightsUrl);
+               } elseif( $wgRightsText ){
+                       $this->element( 'rights', $wgRightsText );
+               }
        }
-}
 
-/* private */ function ccGetTerms($url) {
-       global $wgLicenseTerms;
-       
-       if (isset($wgLicenseTerms)) {
-               return $wgLicenseTerms;
-       } else {
-               $known = getKnownLicenses();
-               return $known[$url];
+       protected function getTerms( $url ){
+               global $wgLicenseTerms;
+
+               if( $wgLicenseTerms ){
+                       return $wgLicenseTerms;
+               } else {
+                       $known = $this->getKnownLicenses();
+                       if( isset( $known[$url] ) ) {
+                               return $known[$url];
+                       } else {
+                               return array();
+                       }
+               }
        }
-}
 
-/* private */ function getKnownLicenses() {
-       
-       $ccLicenses = array('by', 'by-nd', 'by-nd-nc', 'by-nc', 
-                           'by-nc-sa', 'by-sa', 'nd', 'nd-nc',
-                           'nc', 'nc-sa', 'sa');
-       
-       $knownLicenses = array();
-       
-       foreach ($ccLicenses as $license) {
-               $lurl = "http://creativecommons.org/licenses/{$license}/1.0/";
-               $knownLicenses[$lurl] = explode('-', $license);
-               $knownLicenses[$lurl][] = 're';
-               $knownLicenses[$lurl][] = 'di';
-               $knownLicenses[$lurl][] = 'no';
-               if (!in_array('nd', $knownLicenses[$lurl])) {
-                       $knownLicenses[$lurl][] = 'de';
+       protected function getKnownLicenses() {
+               $ccLicenses = array('by', 'by-nd', 'by-nd-nc', 'by-nc',
+                                                       'by-nc-sa', 'by-sa');
+               $ccVersions = array('1.0', '2.0');
+               $knownLicenses = array();
+
+               foreach ($ccVersions as $version) {
+                       foreach ($ccLicenses as $license) {
+                               if( $version == '2.0' && substr( $license, 0, 2) != 'by' ) {
+                                       # 2.0 dropped the non-attribs licenses
+                                       continue;
+                               }
+                               $lurl = "http://creativecommons.org/licenses/{$license}/{$version}/";
+                               $knownLicenses[$lurl] = explode('-', $license);
+                               $knownLicenses[$lurl][] = 're';
+                               $knownLicenses[$lurl][] = 'di';
+                               $knownLicenses[$lurl][] = 'no';
+                               if (!in_array('nd', $knownLicenses[$lurl])) {
+                                       $knownLicenses[$lurl][] = 'de';
+                               }
+                       }
                }
+
+               /* Handle the GPL and LGPL, too. */
+
+               $knownLicenses['http://creativecommons.org/licenses/GPL/2.0/'] =
+                 array('de', 're', 'di', 'no', 'sa', 'sc');
+               $knownLicenses['http://creativecommons.org/licenses/LGPL/2.1/'] =
+                 array('de', 're', 'di', 'no', 'sa', 'sc');
+               $knownLicenses['http://www.gnu.org/copyleft/fdl.html'] =
+                 array('de', 're', 'di', 'no', 'sa', 'sc');
+
+               return $knownLicenses;
        }
-       
-       /* Handle the GPL and LGPL, too. */
-       
-       $knownLicenses["http://creativecommons.org/licenses/GPL/2.0/"] =
-               array('de', 're', 'di', 'no', 'sa', 'sc');
-       $knownLicenses["http://creativecommons.org/licenses/LGPL/2.1/"] = 
-               array('de', 're', 'di', 'no', 'sa', 'sc');
-       $knownLicenses["http://www.gnu.org/copyleft/fdl.html"] = 
-               array('de', 're', 'di', 'no', 'sa', 'sc');
-       
-       return $knownLicenses;
 }
 
-?>