utf8/nucleus/xmlrpc/server.php

   1 <?php
   2 /*
   3  * Nucleus: PHP/MySQL Weblog CMS (http://nucleuscms.org/)
   4  * Copyright (C) 2002-2009 The Nucleus Group
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version 2
   9  * of the License, or (at your option) any later version.
  10  * (see nucleus/documentation/index.html#license for more info)
  11  */
  12
  13 /**
  14  * This script is provides an XML-RPC [1] interface to Nucleus [2].
  15  *
  16  * At this time, the Blogger API [3], the metaWeblog API [4] and
  17  * parts of the Movable Type API [5] are implemented
  18  *
  19  * This script uses the the 'XML-RPC for PHP v1.02' implementation [6]
  20  * All other code was written by Wouter Demuynck [7]
  21  *
  22  * [1] http://www.xmlrpc.com/
  23  * [2] http://nucleuscms.org/
  24  * [3] http://plant.blogger.com/api/
  25  * [4] http://www.xmlrpc.com/metaWeblogApi
  26  * [5] http://www.movabletype.org/docs/mtmanual_programmatic.html
  27  * [6] http://phpxmlrpc.sourceforge.net/
  28  * [7] http://demuynck.org/
  29  *
  30  *
  31  * The Blogger API: (more info in the documentation)
  32  *
  33  *      blogger.newPost
  34  *      blogger.editPost
  35  *      blogger.getUsersBlogs
  36  *      blogger.deletePost
  37  *      blogger.getRecentPosts
  38  *      blogger.getPost
  39  *      blogger.getUserInfo
  40  *      blogger.getTemplate
  41  *      blogger.setTemplate
  42  *
  43  *      Note: The getUserInfo response contains an empty 'lastname' and the full name as
  44  *       'firstname'
  45  * Note: Blogger API methods only affect the body field of items
  46  *
  47  * The metaWeblog API (more info in documentation)
  48  *
  49  * metaWeblog.newPost
  50  * metaWeblog.getPost
  51  * metaWeblog.editPost
  52  * metaWeblog.getCategories
  53  * metaWeblog.newMediaObject
  54  * metaWeblog.getRecentPosts
  55  *
  56  * Note: metaWeblog API methods only affect the body and title fields of items.
  57  *       the extended part is left untouched (and empty for new posts)
  58  *
  59  * The Movable Type API
  60  *
  61  * mt.supportedMethods
  62  *
  63  * @license http://nucleuscms.org/license.txt GNU General Public License
  64  * @copyright Copyright (C) 2002-2009 The Nucleus Group
  65  * @version $Id$
  66  * @version $NucleusJP: server.php,v 1.8.2.1 2007/09/07 07:12:42 kimitake Exp $
  67  */
  68 $CONF = array();
  69 require("../../config.php");    // include Nucleus libs and code
  70 include($DIR_LIBS . "xmlrpc.inc.php");
  71 include($DIR_LIBS . "xmlrpcs.inc.php");
  72
  73 /* define xmlrpc settings */
  74 $xmlrpc_internalencoding = _CHARSET;
  75 $xmlrpc_defencoding = 'UTF-8';
  76
  77 /* definition of available methods */
  78
  79 $functionDefs = array();
  80
  81 // load server functions
  82 include('api_blogger.inc.php');
  83 include('api_metaweblog.inc.php');
  84 // include('api_nucleus.inc.php'); // uncomment if you still want to use the nucleus.* methods
  85 include('api_mt.inc.php');
  86
  87
  88 // create server
  89 $s = new xmlrpc_server( $functionDefs );
  90
  91
  92 /* ------------------------------ private functions ---------------------------------- */
  93
  94 /**
  95   * Adds an item to the given blog. Username and password are required to login
  96   */
  97 function _addItem($blogid, $username, $password, $title, $body, $more, $publish, $closed, $catname = "") {
  98         $blog = new BLOG($blogid);
  99         $timestamp = $blog->getCorrectTime();
 100         return _addDatedItem($blogid, $username, $password, $title, $body, $more, $publish, $closed, $timestamp, 0, $catname);
 101 }
 102
 103 /**
 104   * Adds item to blog, with time of item given
 105   */
 106 function _addDatedItem($blogid, $username, $password, $title, $body, $more, $publish, $closed, $timestamp, $future, $catname = "") {
 107         // 1. login
 108         $mem = new MEMBER();
 109
 110         if (!$mem->login($username, $password))
 111                 return _error(1,"Could not log in");
 112
 113         // 2. check if allowed to add to blog
 114         if (!BLOG::existsID($blogid))
 115                 return _error(2,"No such blog ($blogid)");
 116         if (!$mem->teamRights($blogid))
 117                 return _error(3,"Not a team member");
 118         if (!trim($body))
 119                 return _error(4,"Cannot add empty items!");
 120
 121         // 3. calculate missing vars
 122         $blog = new BLOG($blogid);
 123
 124         // get category id (or id for default category when false category)
 125         $catid = $blog->getCategoryIdFromName($catname);
 126
 127         if ($publish == 1)
 128                 $draft = 0;
 129         else
 130                 $draft = 1;
 131         if ($closed != 1)
 132                 $closed = 0;
 133
 134         // 4. add to blog
 135         $itemid = $blog->additem($catid, $title, $body, $more, $blogid, $mem->getID(), $timestamp, $closed, $draft);
 136
 137         // [TODO] ping weblogs.com ?
 138
 139         return new xmlrpcresp(new xmlrpcval($itemid,"string"));
 140 }
 141
 142 /**
 143   * Updates an item. Username and password are required to login
 144   */
 145 function _edititem($itemid, $username, $password, $catid, $title, $body, $more, $wasdraft, $publish, $closed) {
 146         global $manager;
 147
 148         // 1. login
 149         $mem = new MEMBER();
 150         if (!$mem->login($username, $password))
 151                 return _error(1,"Could not log in");
 152
 153         // 2. check if allowed to add to blog
 154         if (!$manager->existsItem($itemid,1,1))
 155                 return _error(6,"No such item ($itemid)");
 156         if (!$mem->canAlterItem($itemid))
 157                 return _error(7,"Not allowed to alter item");
 158
 159         // 3. update item
 160         ITEM::update($itemid, $catid, $title, $body, $more, $closed, $wasdraft, $publish, 0);
 161
 162         return new xmlrpcresp(new xmlrpcval(1,"boolean"));
 163 }
 164
 165 /**
 166   * Gives the list of blogs to which the user with given name and password has access
 167   */
 168 function _getUsersBlogs($username, $password) {
 169         // 1. Try to login
 170         $mem = new MEMBER();
 171         if (!$mem->login($username, $password))
 172                 return _error(1,"Could not log in");
 173
 174         // 2. Get list of blogs
 175
 176         $structarray = array();
 177         $query =  "SELECT bnumber, bname, burl"
 178                         . ' FROM '.sql_table('blog').', '.sql_table('team')
 179                         . " WHERE tblog=bnumber and tmember=" . $mem->getID()
 180                         . " ORDER BY bname";
 181         $r = sql_query($query);
 182
 183         while ($obj = mysql_fetch_object($r)) {
 184                 if ($obj->burl)
 185                         $blogurl = $obj->burl;
 186                 else
 187                         $blogurl = 'http://';
 188
 189                 $newstruct = new xmlrpcval(array(
 190                         "url" => new xmlrpcval($blogurl,"string"),
 191                         "blogid" => new xmlrpcval($obj->bnumber,"string"),
 192                         "blogName" => new xmlrpcval($obj->bname,"string")
 193                 ),'struct');
 194                 array_push($structarray, $newstruct);
 195         }
 196
 197         return new xmlrpcresp(new xmlrpcval( $structarray , "array"));
 198 }
 199
 200
 201 function _getUserInfo($username, $password) {
 202         // 1. login
 203         $mem = new MEMBER();
 204         if (!$mem->login($username, $password))
 205                 return _error(1,"Could not log in");
 206
 207         // 3. return the info
 208         // Structure returned has nickname, userid, url, email, lastname, firstname
 209
 210         $newstruct = new xmlrpcval(array(
 211                 "nickname" => new xmlrpcval($mem->getDisplayName(),"string"),
 212                 "userid" => new xmlrpcval($mem->getID(),"string"),
 213                 "url" => new xmlrpcval($mem->getURL(),"string"),
 214                 "email" => new xmlrpcval($mem->getEmail(),"string"),
 215                 "lastname" => new xmlrpcval("","string"),
 216                 "firstname" => new xmlrpcval($mem->getRealName(),"string")
 217         ),'struct');
 218
 219         return new xmlrpcresp($newstruct);
 220
 221
 222 }
 223
 224 /**
 225   * deletes an item
 226   */
 227 function _deleteItem($itemid, $username, $password) {
 228         global $manager;
 229
 230         // 1. login
 231         $mem = new MEMBER();
 232         if (!$mem->login($username, $password))
 233                 return _error(1,"Could not log in");
 234
 235         // 2. check if allowed
 236         if (!$manager->existsItem($itemid,1,1))
 237                 return _error(6,"No such item ($itemid)");
 238         $blogid = getBlogIDFromItemID($itemid);
 239         if (!$mem->teamRights($blogid))
 240                 return _error(3,"Not a team member");
 241
 242         // delete the item
 243         ITEM::delete($itemid);
 244
 245         return new xmlrpcresp(new xmlrpcval(1,"boolean"));
 246 }
 247
 248 /**
 249   * Returns a template
 250   */
 251 function _getSkinPart($blogid, $username, $password, $type) {
 252         // 1. login
 253         $mem = new MEMBER();
 254         if (!$mem->login($username, $password))
 255                 return _error(1,"Could not log in");
 256
 257         // 2. check if allowed
 258         if (!BLOG::existsID($blogid))
 259                 return _error(2,"No such blog ($blogid)");
 260         if (!$mem->teamRights($blogid))
 261                 return _error(3,"Not a team member");
 262
 263         // 3. return skin part
 264         $blog = new BLOG($blogid);
 265         $skin = new SKIN($blog->getDefaultSkin());
 266         return new xmlrpcresp(new xmlrpcval($skin->getContent($type),"string"));
 267
 268 }
 269
 270 function _setSkinPart($blogid, $username, $password, $content, $type) {
 271         // 1. login
 272         $mem = new MEMBER();
 273         if (!$mem->login($username, $password))
 274                 return _error(1,"Could not log in");
 275
 276         // 2. check if allowed
 277         if (!BLOG::existsID($blogid))
 278                 return _error(2,"No such blog ($blogid)");
 279         if (!$mem->teamRights($blogid))
 280                 return _error(3,"Not a team member");
 281
 282         // 3. update skin part
 283         $blog = new BLOG($blogid);
 284         $skin = new SKIN($blog->getDefaultSkin());
 285         $skin->update($type, $content);
 286
 287         return new xmlrpcresp(new xmlrpcval(1,'boolean'));
 288 }
 289
 290 /**
 291   * Some convenience methods
 292   */
 293
 294 function _getScalar($m, $idx) {
 295         $v = $m->getParam($idx);
 296         return $v->scalarval();
 297 }
 298
 299 function _getStructVal($struct, $key) {
 300         $t = $struct->structmem($key);
 301         if (!$t)
 302                 return '';      // no such struct value
 303         else
 304                 return $t->scalarval();
 305 }
 306
 307 function _getArrayVal($a, $idx) {
 308         $t = $a->arraymem($idx);
 309         return $t->scalarval();
 310 }
 311
 312 /**
 313   * Returns an XML-RPC error response
 314   * $err is the error number (>0, will be added to $xmlrpcerruser)
 315   */
 316 function _error($err, $msg) {
 317         global $xmlrpcerruser;
 318         return new xmlrpcresp(0, $xmlrpcerruser + $err, $msg);
 319 }
 320 ?>