LeechCraft  0.6.70-3565-g2d86529
Modular cross-platform feature rich live environment.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
resourceloader.cpp
Go to the documentation of this file.
1 /**********************************************************************
2  * LeechCraft - modular cross-platform feature rich internet client.
3  * Copyright (C) 2006-2014 Georg Rudoy
4  *
5  * Boost Software License - Version 1.0 - August 17th, 2003
6  *
7  * Permission is hereby granted, free of charge, to any person or organization
8  * obtaining a copy of the software and accompanying documentation covered by
9  * this license (the "Software") to use, reproduce, display, distribute,
10  * execute, and transmit the Software, and to prepare derivative works of the
11  * Software, and to permit third-parties to whom the Software is furnished to
12  * do so, all subject to the following:
13  *
14  * The copyright notices in the Software and this entire statement, including
15  * the above license grant, this restriction and the following disclaimer,
16  * must be included in all copies of the Software, in whole or in part, and
17  * all derivative works of the Software, unless such copies or derivative
18  * works are solely in the form of machine-executable object code generated by
19  * a source language processor.
20  *
21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23  * FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
24  * SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
25  * FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
26  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27  * DEALINGS IN THE SOFTWARE.
28  **********************************************************************/
29 
30 #include "resourceloader.h"
31 #include <QApplication>
32 #include <QFile>
33 #include <QDir>
34 #include <QStandardItemModel>
35 #include <QSortFilterProxyModel>
36 #include <QFileSystemWatcher>
37 #include <QTimer>
38 #include <QtDebug>
39 #include <QBuffer>
40 
41 namespace LeechCraft
42 {
43  namespace Util
44  {
45  ResourceLoader::ResourceLoader (const QString& relPath, QObject* parent)
46  : QObject (parent)
47  , RelativePath_ (relPath)
48  , SubElemModel_ (new QStandardItemModel (this))
49  , AttrFilters_ (QDir::Dirs | QDir::NoDotAndDotDot | QDir::Readable)
50  , SortModel_ (new QSortFilterProxyModel (this))
51  , Watcher_ (new QFileSystemWatcher (this))
52  , CacheFlushTimer_ (new QTimer (this))
53  , CachePathContents_ (0)
54  , CachePixmaps_ (0)
55  {
56  if (RelativePath_.startsWith ('/'))
57  RelativePath_ = RelativePath_.mid (1);
58  if (!RelativePath_.endsWith ('/'))
59  RelativePath_.append ('/');
60 
61  SortModel_->setDynamicSortFilter (true);
62  SortModel_->setSourceModel (SubElemModel_);
63  SortModel_->sort (0);
64 
65  connect (Watcher_,
66  SIGNAL (directoryChanged (const QString&)),
67  this,
68  SLOT (handleDirectoryChanged (const QString&)));
69 
70  connect (CacheFlushTimer_,
71  SIGNAL (timeout ()),
72  this,
73  SLOT (handleFlushCaches ()));
74  }
75 
76  void ResourceLoader::AddLocalPrefix (QString prefix)
77  {
78  if (!prefix.isEmpty () &&
79  !prefix.endsWith ('/'))
80  prefix.append ('/');
81  QString result = QDir::homePath () + "/.leechcraft/data/" + prefix;
82  LocalPrefixesChain_ << result;
83 
84  QDir testDir = QDir::home ();
85  if (!testDir.exists (".leechcraft/data/" + prefix + RelativePath_))
86  {
87  qDebug () << Q_FUNC_INFO
88  << ".leechcraft/data/" + prefix + RelativePath_
89  << "doesn't exist, trying to create it...";
90 
91  if (!testDir.mkpath (".leechcraft/data/" + prefix + RelativePath_))
92  {
93  qWarning () << Q_FUNC_INFO
94  << "failed to create"
95  << ".leechcraft/data/" + prefix + RelativePath_;
96  }
97  }
98 
99  ScanPath (result + RelativePath_);
100 
101  Watcher_->addPath (result + RelativePath_);
102  }
103 
105  {
106 #ifdef Q_OS_MAC
107  QStringList prefixes = QApplication::arguments ().contains ("-nobundle") ?
108  QStringList ("/usr/local/share/leechcraft/") :
109  QStringList (QApplication::applicationDirPath () + "/../Resources/share/");
110 #elif defined (Q_OS_WIN32)
111  QStringList prefixes = QStringList (QApplication::applicationDirPath () + "/share/");
112 #elif defined (INSTALL_PREFIX)
113  QStringList prefixes = QStringList (INSTALL_PREFIX "/share/leechcraft/");
114 #else
115  QStringList prefixes = QStringList ("/usr/local/share/leechcraft/")
116  << "/usr/share/leechcraft/";
117 #endif
118  bool hasBeenAdded = false;
119  for (const QString& prefix : prefixes)
120  {
121  GlobalPrefixesChain_ << prefix;
122  ScanPath (prefix + RelativePath_);
123 
124  if (QFile::exists (prefix + RelativePath_))
125  {
126  Watcher_->addPath (prefix + RelativePath_);
127  hasBeenAdded = true;
128  }
129  }
130 
131  if (!hasBeenAdded)
132  qWarning () << Q_FUNC_INFO
133  << "no prefixes have been added:"
134  << prefixes
135  << "; rel path:"
136  << RelativePath_;
137  }
138 
139  void ResourceLoader::SetCacheParams (int size, int timeout)
140  {
141  if (qApp->property ("no-resource-caching").toBool ())
142  return;
143 
144  if (size <= 0)
145  {
146  CacheFlushTimer_->stop ();
147 
148  handleFlushCaches ();
149  }
150  else
151  {
152  if (timeout > 0)
153  CacheFlushTimer_->start (timeout);
154 
155  CachePathContents_.setMaxCost (size * 1024);
156  CachePixmaps_.setMaxCost (size * 1024);
157  }
158  }
159 
161  {
162  handleFlushCaches ();
163  }
164 
165  QFileInfoList ResourceLoader::List (const QString& option,
166  const QStringList& nameFilters, QDir::Filters filters) const
167  {
168  QSet<QString> alreadyListed;
169  QFileInfoList result;
170  for (const auto& prefix : LocalPrefixesChain_ + GlobalPrefixesChain_)
171  {
172  const QString& path = prefix + RelativePath_ + option;
173  QDir dir (path);
174  const QFileInfoList& list =
175  dir.entryInfoList (nameFilters, filters);
176  for (const auto& info : list)
177  {
178  const QString& fname = info.fileName ();
179  if (alreadyListed.contains (fname))
180  continue;
181 
182  alreadyListed << fname;
183  result << info;
184  }
185  }
186 
187  return result;
188  }
189 
190  QString ResourceLoader::GetPath (const QStringList& pathVariants) const
191  {
192  for (const auto& prefix : LocalPrefixesChain_ + GlobalPrefixesChain_)
193  for (const auto& path : pathVariants)
194  {
195  const QString& can = QFileInfo (prefix + RelativePath_ + path).absoluteFilePath ();
196  if (QFile::exists (can))
197  return can;
198  }
199 
200  return QString ();
201  }
202 
203  namespace
204  {
205  QStringList IconizeBasename (const QString& basename)
206  {
207  QStringList variants;
208  variants << basename + ".svg"
209  << basename + ".png"
210  << basename + ".jpg"
211  << basename + ".gif";
212  return variants;
213  }
214  }
215 
216  QString ResourceLoader::GetIconPath (const QString& basename) const
217  {
218  return GetPath (IconizeBasename (basename));
219  }
220 
221  QIODevice_ptr ResourceLoader::Load (const QStringList& pathVariants, bool open) const
222  {
223  QString path = GetPath (pathVariants);
224  if (path.isNull ())
225  return QIODevice_ptr ();
226 
227  if (CachePathContents_.contains (path))
228  {
229  std::shared_ptr<QBuffer> result (new QBuffer ());
230  result->setData (*CachePathContents_ [path]);
231  if (open)
232  result->open (QIODevice::ReadOnly);
233  return result;
234  }
235 
236  std::shared_ptr<QFile> result (new QFile (path));
237 
238  if (!result->isSequential () &&
239  result->size () < CachePathContents_.maxCost () / 2)
240  {
241  if (result->open (QIODevice::ReadOnly))
242  {
243  const QByteArray& data = result->readAll ();
244  CachePathContents_.insert (path, new QByteArray (data), data.size ());
245  result->close ();
246  }
247  }
248 
249  if (open)
250  result->open (QIODevice::ReadOnly);
251 
252  return result;
253  }
254 
255  QIODevice_ptr ResourceLoader::Load (const QString& pathVariant, bool open) const
256  {
257  return Load (QStringList (pathVariant), open);
258  }
259 
260  QIODevice_ptr ResourceLoader::GetIconDevice (const QString& basename, bool open) const
261  {
262  return Load (IconizeBasename (basename), open);
263  }
264 
265  QPixmap ResourceLoader::LoadPixmap (const QString& basename) const
266  {
267  if (CachePixmaps_.contains (basename))
268  return *CachePixmaps_ [basename];
269 
270  auto dev = GetIconDevice (basename, true);
271  if (!dev)
272  return QPixmap ();
273 
274  const auto& data = dev->readAll ();
275 
276  QPixmap result;
277  result.loadFromData (data);
278  CachePixmaps_.insert (basename, new QPixmap (result), data.size ());
279  return result;
280  }
281 
282  QAbstractItemModel* ResourceLoader::GetSubElemModel () const
283  {
284  return SortModel_;
285  }
286 
287  void ResourceLoader::SetAttrFilters (QDir::Filters filters)
288  {
289  AttrFilters_ = filters;
290  }
291 
292  void ResourceLoader::SetNameFilters (const QStringList& filters)
293  {
294  NameFilters_ = filters;
295  }
296 
297  void ResourceLoader::ScanPath (const QString& path)
298  {
299  for (const auto& entry : QDir (path).entryList (NameFilters_, AttrFilters_))
300  {
301  Entry2Paths_ [entry] << path;
302  if (SubElemModel_->findItems (entry).size ())
303  continue;
304 
305  SubElemModel_->appendRow (new QStandardItem (entry));
306  }
307  }
308 
309  void ResourceLoader::handleDirectoryChanged (const QString& path)
310  {
312 
313  for (auto i = Entry2Paths_.begin (), end = Entry2Paths_.end (); i != end; ++i)
314  i->removeAll (path);
315 
316  QFileInfo fi (path);
317  if (fi.exists () &&
318  fi.isDir () &&
319  fi.isReadable ())
320  ScanPath (path);
321 
322  QStringList toRemove;
323  for (auto i = Entry2Paths_.begin (), end = Entry2Paths_.end (); i != end; ++i)
324  if (i->isEmpty ())
325  toRemove << i.key ();
326 
327  for (const auto& entry : toRemove)
328  {
329  Entry2Paths_.remove (entry);
330 
331  auto items = SubElemModel_->findItems (entry);
332  for (auto item : SubElemModel_->findItems (entry))
333  SubElemModel_->removeRow (item->row ());
334  }
335  }
336 
337  void ResourceLoader::handleFlushCaches ()
338  {
339  CachePathContents_.clear ();
340  CachePixmaps_.clear ();
341  }
342  }
343 }
QPixmap LoadPixmap(const QString &basename) const
Returns the pixmap for the given basename.
QFileInfoList List(const QString &option, const QStringList &names=QStringList(), QDir::Filters filters=QDir::NoFilter) const
Lists the available files for the given option.
void SetAttrFilters(QDir::Filters)
Sets the attribute filters for the subelement model.
void AddLocalPrefix(QString prefix=QString())
Registers a local search prefix.
QAbstractItemModel * GetSubElemModel() const
Returns the subelement model with the contents of registered paths.
void SetNameFilters(const QStringList &)
Sets the name filters for the subelement model.
void SetCacheParams(int size, int timeout)
Sets the caching parameters of this loader.
void AddGlobalPrefix()
Registers global OS-dependent prefixes.
void FlushCache()
Forcefully flushes the cache.
QString GetPath(const QStringList &pathVariants) const
Returns the first found path for the list of variants.
QString GetIconPath(const QString &basename) const
Calls GetPath() with standard variants for the icon extensions.
ResourceLoader(const QString &relPath, QObject *obj=0)
Initializes the loader with the given path.
std::shared_ptr< QIODevice > QIODevice_ptr
QIODevice_ptr GetIconDevice(const QString &basename, bool open=false) const
Returns the QIODevice for the corresponding icon.
QIODevice_ptr Load(const QStringList &pathVariants, bool open=false) const
Returns the QIODevice for the corresponding resource.