1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
5 **
6 ** This file is part of the Qt Assistant of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 or version 3 as published by the Free
20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22 ** following information to ensure the GNU Lesser General Public License
23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 **
26 ** As a special exception, The Qt Company gives you certain additional
27 ** rights. These rights are described in The Qt Company LGPL Exception
28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 **
30 ** GNU General Public License Usage
31 ** Alternatively, this file may be used under the terms of the GNU
32 ** General Public License version 3.0 as published by the Free Software
33 ** Foundation and appearing in the file LICENSE.GPL included in the
34 ** packaging of this file. Please review the following information to
35 ** ensure the GNU General Public License version 3.0 requirements will be
36 ** met: http://www.gnu.org/copyleft/gpl.html.
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41 #include "tracer.h"
42
43 #include <QtCore/QDir>
44 #include <QtCore/QLibraryInfo>
45 #include <QtCore/QDateTime>
46 #include <QtCore/QFileSystemWatcher>
47 #include <QtHelp/QHelpEngineCore>
48 #include "helpenginewrapper.h"
49 #include "qtdocinstaller.h"
50
51 QT_BEGIN_NAMESPACE
52
QtDocInstaller(const QList<DocInfo> & docInfos)53 QtDocInstaller::QtDocInstaller(const QList<DocInfo> &docInfos)
54 : m_abort(false), m_docInfos(docInfos)
55 {
56 TRACE_OBJ
57 }
58
~QtDocInstaller()59 QtDocInstaller::~QtDocInstaller()
60 {
61 TRACE_OBJ
62 if (!isRunning())
63 return;
64 m_mutex.lock();
65 m_abort = true;
66 m_mutex.unlock();
67 wait();
68 }
69
installDocs()70 void QtDocInstaller::installDocs()
71 {
72 TRACE_OBJ
73 start(LowPriority);
74 }
75
run()76 void QtDocInstaller::run()
77 {
78 TRACE_OBJ
79 m_qchDir = QLibraryInfo::location(QLibraryInfo::DocumentationPath)
80 + QDir::separator() + QLatin1String("qch");
81 m_qchFiles = m_qchDir.entryList(QStringList() << QLatin1String("*.qch"));
82
83 bool changes = false;
84 foreach (const DocInfo &docInfo, m_docInfos) {
85 changes |= installDoc(docInfo);
86 m_mutex.lock();
87 if (m_abort) {
88 m_mutex.unlock();
89 return;
90 }
91 m_mutex.unlock();
92 }
93 emit docsInstalled(changes);
94 }
95
installDoc(const DocInfo & docInfo)96 bool QtDocInstaller::installDoc(const DocInfo &docInfo)
97 {
98 TRACE_OBJ
99 const QString &component = docInfo.first;
100 const QStringList &info = docInfo.second;
101 QDateTime dt;
102 if (!info.isEmpty() && !info.first().isEmpty())
103 dt = QDateTime::fromString(info.first(), Qt::ISODate);
104
105 QString qchFile;
106 if (info.count() == 2)
107 qchFile = info.last();
108
109 if (m_qchFiles.isEmpty()) {
110 emit qchFileNotFound(component);
111 return false;
112 }
113 foreach (const QString &f, m_qchFiles) {
114 if (f.startsWith(component)) {
115 QFileInfo fi(m_qchDir.absolutePath() + QDir::separator() + f);
116 if (dt.isValid() && fi.lastModified().toTime_t() == dt.toTime_t()
117 && qchFile == fi.absoluteFilePath())
118 return false;
119 emit registerDocumentation(component, fi.absoluteFilePath());
120 return true;
121 }
122 }
123
124 emit qchFileNotFound(component);
125 return false;
126 }
127
128 QT_END_NAMESPACE
129