runtime/khelpcenter/docentry.cpp

   1 #include "docentry.h"
   2
   3 #include <QRegExp>
   4 #include <QFileInfo>
   5
   6 #include <KDebug>
   7 #include <KDesktopFile>
   8 #include <KUrl>
   9 #include <KStandardDirs>
  10 #include <KApplication>
  11 #include <KRandom>
  12
  13 #include "prefs.h"
  14
  15 using namespace KHC;
  16
  17 DocEntry::DocEntry()
  18 {
  19   init();
  20 }
  21
  22 DocEntry::DocEntry( const QString &name, const QString &url,
  23                     const QString &icon )
  24 {
  25   init();
  26
  27   mName = name;
  28   mUrl = url;
  29   mIcon = icon;
  30 }
  31
  32 void DocEntry::init()
  33 {
  34   mWeight = 0;
  35   mSearchEnabled = false;
  36   mDirectory = false;
  37   mParent = 0;
  38   mNextSibling = 0;
  39 }
  40
  41 void DocEntry::setName( const QString &name )
  42 {
  43   mName = name;
  44 }
  45
  46 QString DocEntry::name() const
  47 {
  48   return mName;
  49 }
  50
  51 void DocEntry::setSearch( const QString &search )
  52 {
  53   mSearch = search;
  54 }
  55
  56 QString DocEntry::search() const
  57 {
  58   return mSearch;
  59 }
  60
  61 void DocEntry::setIcon( const QString &icon )
  62 {
  63   mIcon = icon;
  64 }
  65
  66 QString DocEntry::icon() const
  67 {
  68   if ( !mIcon.isEmpty() ) return mIcon;
  69
  70   if ( !docExists() ) return QLatin1String("unknown");
  71
  72   if ( isDirectory() ) return QLatin1String("contents2");
  73   else return "document2";
  74 }
  75
  76 void DocEntry::setUrl( const QString &url )
  77 {
  78   mUrl = url;
  79 }
  80
  81 QString DocEntry::url() const
  82 {
  83   if ( !mUrl.isEmpty() ) return mUrl;
  84
  85   if ( identifier().isEmpty() ) return QString();
  86
  87   return "khelpcenter:" + identifier();
  88 }
  89
  90 void DocEntry::setInfo( const QString &info )
  91 {
  92   mInfo = info;
  93 }
  94
  95 QString DocEntry::info() const
  96 {
  97   return mInfo;
  98 }
  99
 100 void DocEntry::setLang( const QString &lang )
 101 {
 102   mLang = lang;
 103 }
 104
 105 QString DocEntry::lang() const
 106 {
 107   return mLang;
 108 }
 109
 110 void DocEntry::setIdentifier( const QString &identifier )
 111 {
 112   mIdentifier = identifier;
 113 }
 114
 115 QString DocEntry::identifier() const
 116 {
 117   if ( mIdentifier.isEmpty() ) mIdentifier = KRandom::randomString( 15 );
 118   return mIdentifier;
 119 }
 120
 121 void DocEntry::setIndexer( const QString &indexer )
 122 {
 123   mIndexer = indexer;
 124 }
 125
 126 QString DocEntry::indexer() const
 127 {
 128   return mIndexer;
 129 }
 130
 131 void DocEntry::setIndexTestFile( const QString &indexTestFile )
 132 {
 133   mIndexTestFile = indexTestFile;
 134 }
 135
 136 QString DocEntry::indexTestFile() const
 137 {
 138   return mIndexTestFile;
 139 }
 140
 141 void DocEntry::setWeight( int weight )
 142 {
 143   mWeight = weight;
 144 }
 145
 146 int DocEntry::weight() const
 147 {
 148   return mWeight;
 149 }
 150
 151 void DocEntry::setSearchMethod( const QString &method )
 152 {
 153   mSearchMethod = method;
 154 }
 155
 156 QString DocEntry::searchMethod() const
 157 {
 158   return mSearchMethod;
 159 }
 160
 161 void DocEntry::setDocumentType( const QString &str )
 162 {
 163   mDocumentType = str;
 164 }
 165
 166 QString DocEntry::documentType() const
 167 {
 168   return mDocumentType;
 169 }
 170
 171 QString DocEntry::khelpcenterSpecial() const
 172 {
 173   return mKhelpcenterSpecial;
 174 }
 175
 176 void DocEntry::enableSearch( bool enabled )
 177 {
 178   mSearchEnabled = enabled;
 179 }
 180
 181 bool DocEntry::searchEnabled() const
 182 {
 183   return mSearchEnabled;
 184 }
 185
 186 void DocEntry::setSearchEnabledDefault( bool enabled )
 187 {
 188   mSearchEnabledDefault = enabled;
 189 }
 190
 191 bool DocEntry::searchEnabledDefault() const
 192 {
 193   return mSearchEnabledDefault;
 194 }
 195
 196 void DocEntry::setDirectory( bool dir )
 197 {
 198   mDirectory = dir;
 199 }
 200
 201 bool DocEntry::isDirectory() const
 202 {
 203   return mDirectory;
 204 }
 205
 206 bool DocEntry::readFromFile( const QString &fileName )
 207 {
 208   KDesktopFile file( fileName );
 209   KConfigGroup desktopGroup = file.desktopGroup();
 210
 211   mName = file.readName();
 212   mSearch = desktopGroup.readEntry( "X-DOC-Search" );
 213   mIcon = file.readIcon();
 214   mUrl = file.readDocPath();
 215   mInfo = desktopGroup.readEntry( "Info" );
 216   if ( mInfo.isNull() ) {
 217     mInfo = desktopGroup.readEntry( "Comment" );
 218   }
 219   mLang = desktopGroup.readEntry( "Lang", "en" );
 220   mIdentifier = desktopGroup.readEntry( "X-DOC-Identifier" );
 221   if ( mIdentifier.isEmpty() ) {
 222     QFileInfo fi( fileName );
 223     mIdentifier = fi.completeBaseName();
 224   }
 225   mIndexer = desktopGroup.readEntry( "X-DOC-Indexer" );
 226   mIndexer.replace( "%f", fileName );
 227   mIndexTestFile = desktopGroup.readEntry( "X-DOC-IndexTestFile" );
 228   mSearchEnabledDefault = desktopGroup.readEntry( "X-DOC-SearchEnabledDefault",
 229                                               false );
 230   mSearchEnabled = mSearchEnabledDefault;
 231   mWeight = desktopGroup.readEntry( "X-DOC-Weight", 0 );
 232   mSearchMethod = desktopGroup.readEntry( "X-DOC-SearchMethod" );
 233   mDocumentType = desktopGroup.readEntry( "X-DOC-DocumentType" );
 234
 235   mKhelpcenterSpecial = desktopGroup.readEntry("X-KDE-KHelpcenter-Special");
 236
 237   return true;
 238 }
 239
 240 bool DocEntry::indexExists( const QString &indexDir )
 241 {
 242   QString testFile;
 243   if ( mIndexTestFile.isEmpty() ) {
 244     testFile = identifier() + QLatin1String(".exists");
 245   } else {
 246     testFile = mIndexTestFile;
 247   }
 248
 249   if ( !testFile.startsWith( QLatin1Char('/') ) ) testFile = indexDir + QLatin1Char('/') + testFile;
 250
 251   return QFile::exists( testFile );
 252 }
 253
 254 bool DocEntry::docExists() const
 255 {
 256   if ( !mUrl.isEmpty() ) {
 257     KUrl docUrl( mUrl );
 258     if ( docUrl.isLocalFile() && !KStandardDirs::exists( docUrl.path() ) ) {
 259 //      kDebug(1400) << "URL not found: " << docUrl.url();
 260       return false;
 261     }
 262   }
 263
 264   return true;
 265 }
 266
 267 void DocEntry::addChild( DocEntry *entry )
 268 {
 269   entry->setParent( this );
 270
 271   int i;
 272   for( i = 0; i < mChildren.count(); ++i ) {
 273     if ( i == 0 ) {
 274       if ( entry->weight() < mChildren.first()->weight() ) {
 275         entry->setNextSibling( mChildren.first() );
 276         mChildren.prepend( entry );
 277         break;
 278       }
 279     }
 280     if ( i + 1 < mChildren.count() ) {
 281       if ( entry->weight() >= mChildren[ i ]->weight() &&
 282            entry->weight() < mChildren[ i + 1 ]->weight() ) {
 283         entry->setNextSibling( mChildren[ i + 1 ] );
 284         mChildren[ i ]->setNextSibling( entry );
 285         mChildren.insert( mChildren.indexOf(mChildren.at( i + 1 )), entry );
 286         break;
 287       }
 288     }
 289   }
 290   if ( i == mChildren.count() ) {
 291     if ( i > 0 ) {
 292       mChildren.last()->setNextSibling( entry );
 293     }
 294     mChildren.append( entry );
 295   }
 296 }
 297
 298 bool DocEntry::hasChildren()
 299 {
 300   return mChildren.count();
 301 }
 302
 303 DocEntry *DocEntry::firstChild()
 304 {
 305   return mChildren.first();
 306 }
 307
 308 DocEntry::List DocEntry::children()
 309 {
 310   return mChildren;
 311 }
 312
 313 void DocEntry::setParent( DocEntry *parent )
 314 {
 315   mParent = parent;
 316 }
 317
 318 DocEntry *DocEntry::parent()
 319 {
 320   return mParent;
 321 }
 322
 323 void DocEntry::setNextSibling( DocEntry *next )
 324 {
 325   mNextSibling = next;
 326 }
 327
 328 DocEntry *DocEntry::nextSibling()
 329 {
 330   return mNextSibling;
 331 }
 332
 333 bool DocEntry::isSearchable()
 334 {
 335   return !search().isEmpty() && docExists() &&
 336     indexExists( Prefs::indexDirectory() );
 337 }
 338
 339 void DocEntry::dump() const
 340 {
 341   kDebug() << "  <docentry>";
 342   kDebug() << "    <name>" << mName << "</name>";
 343   kDebug() << "    <searchmethod>" << mSearchMethod << "</searchmethod>";
 344   kDebug() << "    <search>" << mSearch << "</search>";
 345   kDebug() << "    <indexer>" << mIndexer << "</indexer>";
 346   kDebug() << "    <indextestfile>" << mIndexTestFile << "</indextestfile>";
 347   kDebug() << "    <icon>" << mIcon << "</icon>";
 348   kDebug() << "    <url>" << mUrl << "</url>";
 349   kDebug() << "    <documenttype>" << mDocumentType << "</documenttype>";
 350   kDebug() << "  </docentry>";
 351 }
 352 // vim:ts=2:sw=2:et