summaryrefslogtreecommitdiffstats
path: root/lib/kio-msits
diff options
context:
space:
mode:
Diffstat (limited to 'lib/kio-msits')
-rw-r--r--lib/kio-msits/Makefile.am14
-rw-r--r--lib/kio-msits/kchmviewer.desktop11
-rwxr-xr-xlib/kio-msits/msits.cpp320
-rwxr-xr-xlib/kio-msits/msits.h79
-rwxr-xr-xlib/kio-msits/msits.protocol24
5 files changed, 448 insertions, 0 deletions
diff --git a/lib/kio-msits/Makefile.am b/lib/kio-msits/Makefile.am
new file mode 100644
index 0000000..53f5205
--- /dev/null
+++ b/lib/kio-msits/Makefile.am
@@ -0,0 +1,14 @@
+METASOURCES = AUTO
+INCLUDES = $(QT_INCLUDES) $(CHM_INCLUDES) $(KDE_INCLUDES) $(LIBCHMFILE_INCLUDES)
+
+kde_module_LTLIBRARIES = kio_msits.la
+
+kio_msits_la_SOURCES = msits.cpp
+kio_msits_la_LIBADD = -lkio $(CHM_LIBS)
+kio_msits_la_LDFLAGS = -module -avoid-version $(QT_LIBS) $(KDE_LDFLAGS) $(KDE_LIBS) $(KDE_PLUGIN)
+
+protocol_DATA = msits.protocol
+protocoldir = $(kde_servicesdir)
+
+# Put it here to avoid creating another directory
+kde_apps_DATA = kchmviewer.desktop
diff --git a/lib/kio-msits/kchmviewer.desktop b/lib/kio-msits/kchmviewer.desktop
new file mode 100644
index 0000000..d97098a
--- /dev/null
+++ b/lib/kio-msits/kchmviewer.desktop
@@ -0,0 +1,11 @@
+[Desktop Entry]
+Categories=Qt;KDE;Utility;
+Encoding=UTF-8
+Type=Application
+Exec=kchmviewer %U
+Icon=kchmviewer.png
+Comment=
+Terminal=0
+Name=KchmViewer
+Comment=A viewer of CHM (MS-Help) files
+MimeType=application/chm
diff --git a/lib/kio-msits/msits.cpp b/lib/kio-msits/msits.cpp
new file mode 100755
index 0000000..cf7cf27
--- /dev/null
+++ b/lib/kio-msits/msits.cpp
@@ -0,0 +1,320 @@
+/***************************************************************************
+ * Copyright (C) 2004-2007 by Georgy Yunaev, gyunaev@ulduzsoft.com *
+ * Please do not use email address above for bug reports; see *
+ * the README file *
+ * *
+ * 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. *
+ * *
+ * 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. *
+ ***************************************************************************/
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <sys/stat.h>
+
+#include <kapplication.h>
+#include <kdebug.h>
+#include <kinstance.h>
+#include <kurl.h>
+#include <kmimemagic.h>
+
+#include <qfile.h>
+#include <qbitarray.h>
+#include <qvaluevector.h>
+
+#include "msits.h"
+#include "libchmurlfactory.h"
+
+using namespace KIO;
+
+extern "C"
+{
+ int kdemain( int argc, char **argv )
+ {
+ kdDebug() << "*** kio_msits Init" << endl;
+
+ KInstance instance( "kio_msits" );
+
+ if ( argc != 4 )
+ {
+ kdDebug() << "Usage: kio_msits protocol domain-socket1 domain-socket2" << endl;
+ exit (-1);
+ }
+
+ ProtocolMSITS slave ( argv[2], argv[3] );
+ slave.dispatchLoop();
+
+ kdDebug() << "*** kio_msits Done" << endl;
+ return 0;
+ }
+}
+
+ProtocolMSITS::ProtocolMSITS (const QCString &pool_socket, const QCString &app_socket)
+ : SlaveBase ("kio_msits", pool_socket, app_socket)
+{
+ m_chmFile = 0;
+}
+
+ProtocolMSITS::~ProtocolMSITS()
+{
+ if ( !m_chmFile )
+ return;
+
+ chm_close (m_chmFile);
+ m_chmFile = 0;
+}
+
+// A simple stat() wrapper
+static bool isDirectory ( const QString & filename )
+{
+ return filename[filename.length() - 1] == '/';
+}
+
+
+void ProtocolMSITS::get( const KURL& url )
+{
+ QString htmdata, fileName;
+ chmUnitInfo ui;
+ QByteArray buf;
+
+ kdDebug() << "kio_msits::get() " << url.path() << endl;
+
+ if ( !parseLoadAndLookup ( url, fileName ) )
+ return; // error() has been called by parseLoadAndLookup
+
+ kdDebug() << "kio_msits::get: parseLoadAndLookup returned " << fileName << endl;
+
+ if ( LCHMUrlFactory::handleFileType( url.path(), htmdata ) )
+ {
+ buf = htmdata.utf8();
+ kdDebug() << "Using special handling for image pages: " << htmdata << endl;
+ }
+ else
+ {
+ if ( isDirectory (fileName) )
+ {
+ error( KIO::ERR_IS_DIRECTORY, url.prettyURL() );
+ return;
+ }
+
+ if ( !ResolveObject ( fileName, &ui) )
+ {
+ kdDebug() << "kio_msits::get: could not resolve filename " << fileName << endl;
+ error( KIO::ERR_DOES_NOT_EXIST, url.prettyURL() );
+ return;
+ }
+
+ buf.resize( ui.length );
+
+ if ( RetrieveObject (&ui, (unsigned char*) buf.data(), 0, ui.length) == 0 )
+ {
+ kdDebug() << "kio_msits::get: could not retrieve filename " << fileName << endl;
+ error( KIO::ERR_NO_CONTENT, url.prettyURL() );
+ return;
+ }
+ }
+
+ totalSize( buf.size() );
+ KMimeMagicResult * result = KMimeMagic::self()->findBufferFileType( buf, fileName );
+ kdDebug() << "Emitting mimetype " << result->mimeType() << endl;
+
+ mimeType( result->mimeType() );
+ data( buf );
+ processedSize( buf.size() );
+
+ finished();
+}
+
+
+bool ProtocolMSITS::parseLoadAndLookup ( const KURL& url, QString& abspath )
+{
+ kdDebug() << "ProtocolMSITS::parseLoadAndLookup (const KURL&) " << url.path() << endl;
+
+ int pos = url.path().find ("::");
+
+ if ( pos == -1 )
+ {
+ error( KIO::ERR_MALFORMED_URL, url.prettyURL() );
+ return false;
+ }
+
+ QString filename = url.path().left (pos);
+ abspath = url.path().mid (pos + 2); // skip ::
+
+ // Some buggy apps add ms-its:/ to the path as well
+ if ( abspath.startsWith( "ms-its:" ) )
+ abspath = abspath.mid( 7 );
+
+ kdDebug() << "ProtocolMSITS::parseLoadAndLookup: filename " << filename << ", path " << abspath << endl;
+
+ if ( filename.isEmpty() )
+ {
+ error( KIO::ERR_MALFORMED_URL, url.prettyURL() );
+ return false;
+ }
+
+ // If the file has been already loaded, nothing to do.
+ if ( m_chmFile && filename == m_openedFile )
+ return true;
+
+ kdDebug() << "Opening a new CHM file " << filename << endl;
+
+ // First try to open a temporary file
+ chmFile * tmpchm;
+
+ if ( (tmpchm = chm_open ( QFile::encodeName (filename))) == 0 )
+ {
+ error( KIO::ERR_COULD_NOT_READ, url.prettyURL() );
+ return false;
+ }
+
+ // Replace an existing file by a new one
+ if ( m_chmFile )
+ chm_close (m_chmFile);
+
+ m_chmFile = tmpchm;
+ m_openedFile = filename;
+
+ kdDebug() << "A CHM file " << filename << " has beed opened successfully" << endl;
+ return true;
+}
+
+/*
+ * Shamelessly stolen from a KDE KIO tutorial
+ */
+static void app_entry(UDSEntry& e, unsigned int uds, const QString& str)
+{
+ UDSAtom a;
+ a.m_uds = uds;
+ a.m_str = str;
+ e.append(a);
+}
+
+ // appends an int with the UDS-ID uds
+ static void app_entry(UDSEntry& e, unsigned int uds, long l)
+ {
+ UDSAtom a;
+ a.m_uds = uds;
+ a.m_long = l;
+ e.append(a);
+}
+
+// internal function
+// fills a directory item with its name and size
+static void app_dir(UDSEntry& e, const QString & name)
+{
+ e.clear();
+ app_entry(e, KIO::UDS_NAME, name);
+ app_entry(e, KIO::UDS_FILE_TYPE, S_IFDIR);
+ app_entry(e, KIO::UDS_SIZE, 1);
+}
+
+// internal function
+// fills a file item with its name and size
+static void app_file(UDSEntry& e, const QString & name, size_t size)
+{
+ e.clear();
+ app_entry(e, KIO::UDS_NAME, name);
+ app_entry(e, KIO::UDS_FILE_TYPE, S_IFREG);
+ app_entry(e, KIO::UDS_SIZE, size);
+}
+
+void ProtocolMSITS::stat (const KURL & url)
+{
+ QString fileName;
+ chmUnitInfo ui;
+
+ kdDebug() << "kio_msits::stat (const KURL& url) " << url.path() << endl;
+
+ if ( !parseLoadAndLookup ( url, fileName ) )
+ return; // error() has been called by parseLoadAndLookup
+
+ if ( !ResolveObject ( fileName, &ui ) )
+ {
+ error( KIO::ERR_DOES_NOT_EXIST, url.prettyURL() );
+ return;
+ }
+
+ kdDebug() << "kio_msits::stat: adding an entry for " << fileName << endl;
+ UDSEntry entry;
+
+ if ( isDirectory ( fileName ) )
+ app_dir(entry, fileName);
+ else
+ app_file(entry, fileName, ui.length);
+
+ statEntry (entry);
+
+ finished();
+}
+
+
+// A local CHMLIB enumerator
+static int chmlib_enumerator (struct chmFile *, struct chmUnitInfo *ui, void *context)
+{
+ ((QValueVector<QString> *) context)->push_back (QString::fromLocal8Bit (ui->path));
+ return CHM_ENUMERATOR_CONTINUE;
+}
+
+
+void ProtocolMSITS::listDir (const KURL & url)
+{
+ QString filepath;
+
+ kdDebug() << "kio_msits::listDir (const KURL& url) " << url.path() << endl;
+
+ if ( !parseLoadAndLookup ( url, filepath ) )
+ return; // error() has been called by parseLoadAndLookup
+
+ filepath += "/";
+
+ if ( !isDirectory (filepath) )
+ {
+ error(KIO::ERR_CANNOT_ENTER_DIRECTORY, url.path());
+ return;
+ }
+
+ kdDebug() << "kio_msits::listDir: enumerating directory " << filepath << endl;
+
+ QValueVector<QString> listing;
+
+ if ( chm_enumerate_dir ( m_chmFile,
+ filepath.local8Bit(),
+ CHM_ENUMERATE_NORMAL | CHM_ENUMERATE_FILES | CHM_ENUMERATE_DIRS,
+ chmlib_enumerator,
+ &listing ) != 1 )
+ {
+ error(KIO::ERR_CANNOT_ENTER_DIRECTORY, url.path());
+ return;
+ }
+
+ UDSEntry entry;
+ unsigned int striplength = filepath.length();
+
+ for ( unsigned int i = 0; i < listing.size(); i++ )
+ {
+ // Strip the direcroty name
+ QString ename = listing[i].mid (striplength);
+
+ if ( isDirectory ( ename ) )
+ app_dir(entry, ename);
+ else
+ app_file(entry, ename, 0);
+
+ listEntry(entry, false);
+ }
+
+ listEntry(entry, true);
+ finished();
+}
diff --git a/lib/kio-msits/msits.h b/lib/kio-msits/msits.h
new file mode 100755
index 0000000..3de7719
--- /dev/null
+++ b/lib/kio-msits/msits.h
@@ -0,0 +1,79 @@
+/***************************************************************************
+ * Copyright (C) 2004-2005 by Georgy Yunaev, gyunaev@ulduzsoft.com *
+ * Please do not use email address above for bug reports; see *
+ * the README file *
+ * *
+ * 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. *
+ * *
+ * 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. *
+ ***************************************************************************/
+
+#ifndef MSITS_H
+#define MSITS_H
+
+
+#include <kio/slavebase.h>
+#include <kurl.h>
+
+#include <qstring.h>
+#include <qcstring.h>
+
+#include "config.h"
+#include "chm_lib.h"
+
+
+class ProtocolMSITS : public KIO::SlaveBase
+{
+public:
+ ProtocolMSITS ( const QCString&, const QCString& );
+ virtual ~ProtocolMSITS();
+
+ virtual void get ( const KURL& );
+ virtual void listDir (const KURL & url);
+ virtual void stat (const KURL & url);
+
+private:
+ // This function does next thing:
+ // - parses the URL to get a file name and URL inside the file;
+ // - loads a new CHM file, if needed;
+ // - returns the parsed URL inside the file;
+ bool parseLoadAndLookup ( const KURL&, QString& abspath );
+
+ // Resolve an object inside a CHM file
+ inline bool ResolveObject (const QString& fileName, chmUnitInfo *ui)
+ {
+ return m_chmFile != NULL && ::chm_resolve_object(m_chmFile, fileName.utf8(), ui) == CHM_RESOLVE_SUCCESS;
+ }
+
+ // Retrieve an object from the CHM file
+ inline size_t RetrieveObject (const chmUnitInfo *ui, unsigned char *buffer, LONGUINT64 fileOffset, LONGINT64 bufferSize)
+ {
+#if USE_BUILTIN_CHMLIB
+ return ::chm_retrieve_object(m_chmFile, ui, buffer,
+ fileOffset, bufferSize);
+#else
+ return ::chm_retrieve_object(m_chmFile, const_cast<chmUnitInfo*>(ui),
+ buffer, fileOffset, bufferSize);
+#endif
+ }
+
+ // An opened file name, if presend
+ QString m_openedFile;
+
+ // a CHM structure file pointer (from chmlib)
+ chmFile * m_chmFile;
+};
+
+
+#endif /* MSITS_H */
diff --git a/lib/kio-msits/msits.protocol b/lib/kio-msits/msits.protocol
new file mode 100755
index 0000000..b087903
--- /dev/null
+++ b/lib/kio-msits/msits.protocol
@@ -0,0 +1,24 @@
+[Protocol]
+exec=kio_msits
+protocol=ms-its
+input=none
+output=filesystem
+reading=true
+listing=Name,Type,Size
+defaultMimetype=text/html
+Description=A kioslave for displaying WinHelp files
+Description[da]=En kioslave til visning af Windows hjælpefiler
+Description[de]=Ein Ein-/Ausgabemodul zur Anzeige von WinHelp-Dateien
+Description[es]=Un kioslave para mostrar archivos WinHelp
+Description[et]=WinHelp-failide kuvamise IO-moodul
+Description[fr]=Un module d'entrée / sortie pour l'affichage des fichiers WinHelp
+Description[hu]=KDE-protokoll WinHelp-fájlok megjelenítéséhez
+Description[it]=Un kioslave per mostrare i file WinHelp
+Description[nl]=Een kioslave voor het weergeven van WinHelp-bestanden
+Description[pl]=kioslave do pokazywania plików WinHelp
+Description[pt]=A 'kioslave' para mostrar ficheiros WinHelp
+Description[pt_BR]=Um kioslave para exibir arquivos WinHelp
+Description[ru]=Обработчик ввода-вывода для файлов WinHelp
+Description[sv]=En I/O-slav för att visa WinHelp-filer
+Description[xx]=xxA kioslave for displaying WinHelp filesxx
+Icon=help