ctkXnatObject.cpp 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438
  1. /*=============================================================================
  2. Library: XNAT/Core
  3. Copyright (c) University College London,
  4. Centre for Medical Image Computing
  5. Licensed under the Apache License, Version 2.0 (the "License");
  6. you may not use this file except in compliance with the License.
  7. You may obtain a copy of the License at
  8. http://www.apache.org/licenses/LICENSE-2.0
  9. Unless required by applicable law or agreed to in writing, software
  10. distributed under the License is distributed on an "AS IS" BASIS,
  11. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. See the License for the specific language governing permissions and
  13. limitations under the License.
  14. =============================================================================*/
  15. #include "ctkXnatObject.h"
  16. #include "ctkXnatObjectPrivate.h"
  17. #include "ctkXnatDataModel.h"
  18. #include "ctkXnatDefaultSchemaTypes.h"
  19. #include "ctkXnatException.h"
  20. #include "ctkXnatResource.h"
  21. #include "ctkXnatResourceFolder.h"
  22. #include "ctkXnatSession.h"
  23. #include <QDateTime>
  24. #include <QDebug>
  25. #include <QStringList>
  26. #include <QVariant>
  27. const QString ctkXnatObject::ID = "ID";
  28. const QString ctkXnatObject::NAME = "name";
  29. const QString ctkXnatObject::LABEL = "label";
  30. //----------------------------------------------------------------------------
  31. ctkXnatObject::ctkXnatObject(const ctkXnatObject&)
  32. {
  33. throw ctkRuntimeException("Copy constructor not implemented");
  34. }
  35. //----------------------------------------------------------------------------
  36. ctkXnatObject::ctkXnatObject(ctkXnatObject* parent, const QString& schemaType)
  37. : d_ptr(new ctkXnatObjectPrivate())
  38. {
  39. this->setParent(parent);
  40. this->setSchemaType(schemaType);
  41. }
  42. //----------------------------------------------------------------------------
  43. ctkXnatObject::ctkXnatObject(ctkXnatObjectPrivate& dd, ctkXnatObject* parent, const QString& schemaType)
  44. : d_ptr(&dd)
  45. {
  46. this->setParent(parent);
  47. this->setSchemaType(schemaType);
  48. }
  49. //----------------------------------------------------------------------------
  50. ctkXnatObject::~ctkXnatObject()
  51. {
  52. Q_D(ctkXnatObject);
  53. foreach (ctkXnatObject* child, d->children)
  54. {
  55. delete child;
  56. }
  57. }
  58. //----------------------------------------------------------------------------
  59. QString ctkXnatObject::id() const
  60. {
  61. return this->property(ID);
  62. }
  63. //----------------------------------------------------------------------------
  64. void ctkXnatObject::setId(const QString& id)
  65. {
  66. this->setProperty(ID, id);
  67. }
  68. //----------------------------------------------------------------------------
  69. QString ctkXnatObject::name() const
  70. {
  71. return this->property(NAME);
  72. }
  73. //----------------------------------------------------------------------------
  74. void ctkXnatObject::setName(const QString& name)
  75. {
  76. this->setProperty(NAME, name);
  77. }
  78. //----------------------------------------------------------------------------
  79. QString ctkXnatObject::description() const
  80. {
  81. Q_D(const ctkXnatObject);
  82. return d->description;
  83. }
  84. //----------------------------------------------------------------------------
  85. void ctkXnatObject::setDescription(const QString& description)
  86. {
  87. Q_D(ctkXnatObject);
  88. d->description = description;
  89. }
  90. //----------------------------------------------------------------------------
  91. QString ctkXnatObject::childDataType() const
  92. {
  93. return "Resources";
  94. }
  95. QDateTime ctkXnatObject::lastModifiedTimeOnServer()
  96. {
  97. Q_D(ctkXnatObject);
  98. QUuid queryId = this->session()->httpHead(this->resourceUri());
  99. QMap<QByteArray, QByteArray> header = this->session()->httpHeadSync(queryId);
  100. QVariant lastModifiedHeader = header.value("Last-Modified");
  101. QDateTime lastModifiedTime;
  102. if (lastModifiedHeader.isValid())
  103. {
  104. QStringList dateformates;
  105. // In case http date formate RFC 822 ( "Sun, 06 Nov 1994 08:49:37 GMT" )
  106. dateformates<<"ddd, dd MMM yyyy HH:mm:ss";
  107. // In case http date formate ANSI ( "Sun Nov 6 08:49:37 1994" )
  108. dateformates<<"ddd MMM d HH:mm:ss yyyy";
  109. // In case http date formate RFC 850 ( "Sunday, 06-Nov-94 08:49:37 GMT" )
  110. dateformates<<"dddd, dd-MMM-yy HH:mm:ss";
  111. QString dateText = lastModifiedHeader.toString();
  112. // Remove "GMT" addition at the end of the http timestamp
  113. if (dateText.indexOf("GMT") != -1)
  114. {
  115. dateText = dateText.left(dateText.length()-4);
  116. }
  117. foreach (QString format, dateformates)
  118. {
  119. lastModifiedTime = QDateTime::fromString(dateText, format);
  120. if (lastModifiedTime.isValid())
  121. break;
  122. }
  123. }
  124. return lastModifiedTime;
  125. }
  126. void ctkXnatObject::setLastModifiedTime(const QDateTime &lastModifiedTime)
  127. {
  128. Q_D(ctkXnatObject);
  129. if (d->lastModifiedTime < lastModifiedTime)
  130. {
  131. d->lastModifiedTime = lastModifiedTime;
  132. }
  133. }
  134. //----------------------------------------------------------------------------
  135. QString ctkXnatObject::property(const QString& name) const
  136. {
  137. Q_D(const ctkXnatObject);
  138. ctkXnatObjectPrivate::PropertyMapConstInterator iter = d->properties.find(name);
  139. if (iter != d->properties.end())
  140. {
  141. return iter.value();
  142. }
  143. return QString::null;
  144. }
  145. //----------------------------------------------------------------------------
  146. void ctkXnatObject::setProperty(const QString& name, const QVariant& value)
  147. {
  148. Q_D(ctkXnatObject);
  149. if (d->properties[name] != value)
  150. {
  151. d->properties.insert(name, value.toString());
  152. d->modified = true; //TODO some internal method for e.g. setting the ID for the first time
  153. }
  154. }
  155. //----------------------------------------------------------------------------
  156. const QMap<QString, QString>& ctkXnatObject::properties() const
  157. {
  158. Q_D(const ctkXnatObject);
  159. return d->properties;
  160. }
  161. //----------------------------------------------------------------------------
  162. ctkXnatObject* ctkXnatObject::parent() const
  163. {
  164. Q_D(const ctkXnatObject);
  165. return d->parent;
  166. }
  167. //----------------------------------------------------------------------------
  168. void ctkXnatObject::setParent(ctkXnatObject* parent)
  169. {
  170. Q_D(ctkXnatObject);
  171. if (d->parent != parent)
  172. {
  173. if (d->parent)
  174. {
  175. d->parent->remove(this);
  176. }
  177. if (parent)
  178. {
  179. parent->add(this);
  180. }
  181. }
  182. }
  183. //----------------------------------------------------------------------------
  184. QList<ctkXnatObject*> ctkXnatObject::children() const
  185. {
  186. Q_D(const ctkXnatObject);
  187. return d->children;
  188. }
  189. //----------------------------------------------------------------------------
  190. void ctkXnatObject::add(ctkXnatObject* child)
  191. {
  192. Q_D(ctkXnatObject);
  193. if (child->parent() != this)
  194. {
  195. child->d_func()->parent = this;
  196. }
  197. bool childExists (false);
  198. foreach (ctkXnatObject* existingChild, d->children)
  199. {
  200. if ((existingChild->id().length() != 0 && existingChild->id() == child->id()) ||
  201. (existingChild->id().length() == 0 && existingChild->name() == child->name()))
  202. {
  203. d->children.replace(d->children.indexOf(existingChild), child);
  204. childExists = true;
  205. qWarning() << "ctkXnatObject::add(): Child already exists -> Replaced child!";
  206. }
  207. }
  208. if (!childExists)
  209. {
  210. d->children.push_back(child);
  211. }
  212. }
  213. //----------------------------------------------------------------------------
  214. void ctkXnatObject::remove(ctkXnatObject* child)
  215. {
  216. Q_D(ctkXnatObject);
  217. if (!d->children.removeOne(child))
  218. {
  219. qWarning() << "ctkXnatObject::remove(): Child does not exist";
  220. }
  221. }
  222. //----------------------------------------------------------------------------
  223. void ctkXnatObject::reset()
  224. {
  225. Q_D(ctkXnatObject);
  226. // d->properties.clear();
  227. d->children.clear();
  228. d->fetched = false;
  229. }
  230. //----------------------------------------------------------------------------
  231. bool ctkXnatObject::isFetched() const
  232. {
  233. Q_D(const ctkXnatObject);
  234. return d->fetched;
  235. }
  236. //----------------------------------------------------------------------------
  237. QString ctkXnatObject::schemaType() const
  238. {
  239. return this->property("xsiType");
  240. }
  241. //----------------------------------------------------------------------------
  242. void ctkXnatObject::setSchemaType(const QString& schemaType)
  243. {
  244. this->setProperty("xsiType", schemaType);
  245. }
  246. //----------------------------------------------------------------------------
  247. void ctkXnatObject::fetch()
  248. {
  249. Q_D(ctkXnatObject);
  250. if (!d->fetched)
  251. {
  252. this->fetchImpl();
  253. d->fetched = true;
  254. }
  255. }
  256. //----------------------------------------------------------------------------
  257. ctkXnatSession* ctkXnatObject::session() const
  258. {
  259. const ctkXnatObject* xnatObject = this;
  260. while (ctkXnatObject* parent = xnatObject->parent())
  261. {
  262. xnatObject = parent;
  263. }
  264. const ctkXnatDataModel* dataModel = dynamic_cast<const ctkXnatDataModel*>(xnatObject);
  265. return dataModel ? dataModel->session() : NULL;
  266. }
  267. //----------------------------------------------------------------------------
  268. void ctkXnatObject::download(const QString& filename)
  269. {
  270. this->downloadImpl(filename);
  271. }
  272. //----------------------------------------------------------------------------
  273. void ctkXnatObject::save(bool overwrite)
  274. {
  275. Q_D(ctkXnatObject);
  276. this->saveImpl(overwrite);
  277. d->modified = false;
  278. }
  279. //----------------------------------------------------------------------------
  280. ctkXnatResource* ctkXnatObject::addResourceFolder(QString foldername, QString format,
  281. QString content, QString tags)
  282. {
  283. if (foldername.size() == 0)
  284. {
  285. throw ctkXnatException("Error creating resource! Foldername must not be empty!");
  286. }
  287. ctkXnatResourceFolder* resFolder = 0;
  288. QList<ctkXnatObject*> children = this->children();
  289. for (unsigned int i = 0; i < children.size(); ++i)
  290. {
  291. resFolder = dynamic_cast<ctkXnatResourceFolder*>(children.at(i));
  292. if (resFolder)
  293. {
  294. break;
  295. }
  296. }
  297. if (!resFolder)
  298. {
  299. resFolder = new ctkXnatResourceFolder();
  300. this->add(resFolder);
  301. }
  302. ctkXnatResource* resource = new ctkXnatResource();
  303. resource->setName(foldername);
  304. if (format.size() != 0)
  305. resource->setFormat(format);
  306. if (content.size() != 0)
  307. resource->setContent(content);
  308. if (tags.size() != 0)
  309. resource->setTags(tags);
  310. resFolder->add(resource);
  311. resource->save();
  312. return resource;
  313. }
  314. //----------------------------------------------------------------------------
  315. bool ctkXnatObject::exists() const
  316. {
  317. return this->session()->exists(this);
  318. }
  319. //----------------------------------------------------------------------------
  320. void ctkXnatObject::saveImpl(bool /*overwrite*/)
  321. {
  322. Q_D(ctkXnatObject);
  323. ctkXnatSession::UrlParameters urlParams;
  324. urlParams["xsi:type"] = this->schemaType();
  325. // Just do this if there is already a valid last-modification-time,
  326. // otherwise the object is not yet on the server!
  327. QDateTime remoteModTime;
  328. if (d->lastModifiedTime.isValid())
  329. {
  330. // TODO Overwrite this for e.g. project and subject which already support modification time!
  331. remoteModTime = this->lastModifiedTimeOnServer();
  332. // If the object has been modified on the server, perform an update
  333. if (d->lastModifiedTime < remoteModTime)
  334. {
  335. qDebug()<<"Object maybe overwritten on server!";
  336. // TODO update from server, since modification time is not really supported
  337. // by xnat right now this is not of high priority
  338. // something like this->updateImpl + setLastModifiedTime()
  339. }
  340. }
  341. const QMap<QString, QString>& properties = this->properties();
  342. QMapIterator<QString, QString> itProperties(properties);
  343. while (itProperties.hasNext())
  344. {
  345. itProperties.next();
  346. if (itProperties.key() == "ID")
  347. continue;
  348. urlParams[itProperties.key()] = itProperties.value();
  349. }
  350. // Execute the update
  351. QUuid queryID = this->session()->httpPut(this->resourceUri(), urlParams);
  352. const QList<QVariantMap> results = this->session()->httpSync(queryID);
  353. // If this xnat object did not exist before on the server set the ID returned by Xnat
  354. if (results.size() == 1 && results[0].size() == 1)
  355. {
  356. QVariant id = results[0][ID];
  357. if (!id.isNull())
  358. {
  359. this->setId(id.toString());
  360. }
  361. }
  362. // Finally update the modification time on the server
  363. remoteModTime = this->lastModifiedTimeOnServer();
  364. d->lastModifiedTime = remoteModTime;
  365. }
  366. //----------------------------------------------------------------------------
  367. void ctkXnatObject::fetchResources(const QString& path)
  368. {
  369. ctkXnatResourceFolder* resFolder = new ctkXnatResourceFolder();
  370. this->add(resFolder);
  371. }
  372. //----------------------------------------------------------------------------
  373. void ctkXnatObject::erase()
  374. {
  375. this->session()->remove(this);
  376. this->parent()->remove(this);
  377. }