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