shell/project.cpp

   1 /* This file is part of the KDE project
   2    Copyright 2001 Matthias Hoelzer-Kluepfel <hoelzer@kde.org>
   3    Copyright 2002-2003 Roberto Raggi <roberto@kdevelop.org>
   4    Copyright 2002 Simon Hausmann <hausmann@kde.org>
   5    Copyright 2003 Jens Dagerbo <jens.dagerbo@swipnet.se>
   6    Copyright 2003 Mario Scalas <mario.scalas@libero.it>
   7    Copyright 2003-2004 Alexander Dymo <adymo@kdevelop.org>
   8    Copyright     2006 Matt Rogers <mattr@kde.org>
   9    Copyright     2007 Andreas Pakulat <apaku@gmx.de>
  10
  11    This library is free software; you can redistribute it and/or
  12    modify it under the terms of the GNU Library General Public
  13    License as published by the Free Software Foundation; either
  14    version 2 of the License, or (at your option) any later version.
  15
  16    This library is distributed in the hope that it will be useful,
  17    but WITHOUT ANY WARRANTY; without even the implied warranty of
  18    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19    Library General Public License for more details.
  20
  21    You should have received a copy of the GNU Library General Public License
  22    along with this library; see the file COPYING.LIB.  If not, write to
  23    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  24    Boston, MA 02110-1301, USA.
  25 */
  26
  27 #include "project.h"
  28
  29 #include <QSet>
  30 #include <QtGlobal>
  31 #include <QFileInfo>
  32 #include <QtDBus/QtDBus>
  33 #include <QStandardItemModel>
  34
  35 #include <kconfig.h>
  36 #include <kconfiggroup.h>
  37 #include <klocale.h>
  38 #include <kio/job.h>
  39 #include <kio/netaccess.h>
  40 #include <kio/global.h>
  41 #include <kmessagebox.h>
  42 #include <kio/jobclasses.h>
  43 #include <ktemporaryfile.h>
  44 #include <kdebug.h>
  45
  46 #include <project/interfaces/iprojectfilemanager.h>
  47 #include <project/interfaces/ibuildsystemmanager.h>
  48 #include <interfaces/iplugin.h>
  49 #include <interfaces/iplugincontroller.h>
  50 #include <interfaces/iruncontroller.h>
  51 #include <project/importprojectjob.h>
  52 #include <project/projectmodel.h>
  53 #include <language/duchain/indexedstring.h>
  54
  55 #include "core.h"
  56 #include "mainwindow.h"
  57 #include "projectcontroller.h"
  58 #include "uicontroller.h"
  59
  60 namespace KDevelop
  61 {
  62
  63 class ProjectPrivate
  64 {
  65 public:
  66     KUrl folder;
  67     KUrl projectFileUrl;
  68     KUrl developerFileUrl;
  69     QString developerTempFile;
  70     QString projectTempFile;
  71     KTemporaryFile* tmp;
  72     IPlugin* manager;
  73     IPlugin* vcsPlugin;
  74     ProjectFolderItem* topItem;
  75     QString name;
  76     KSharedConfig::Ptr m_cfg;
  77     IProject *project;
  78     QSet<KDevelop::IndexedString> fileSet;
  79
  80     QList<ProjectFileItem*> recurseFiles( ProjectBaseItem * projectItem )
  81     {
  82         QList<ProjectFileItem*> files;
  83         if ( ProjectFolderItem * folder = projectItem->folder() )
  84         {
  85             QList<ProjectFolderItem*> folder_list = folder->folderList();
  86             for ( QList<ProjectFolderItem*>::Iterator it = folder_list.begin(); it != folder_list.end(); ++it )
  87             {
  88                 files += recurseFiles( ( *it ) );
  89             }
  90
  91             QList<ProjectTargetItem*> target_list = folder->targetList();
  92             for ( QList<ProjectTargetItem*>::Iterator it = target_list.begin(); it != target_list.end(); ++it )
  93             {
  94                 files += recurseFiles( ( *it ) );
  95             }
  96
  97             files += folder->fileList();
  98         }
  99         else if ( ProjectTargetItem * target = projectItem->target() )
 100         {
 101             files += target->fileList();
 102         }
 103         else if ( ProjectFileItem * file = projectItem->file() )
 104         {
 105             files.append( file );
 106         }
 107         return files;
 108     }
 109
 110     QList<ProjectBaseItem*> itemsForUrlInternal( const KUrl& url, ProjectFolderItem* folder ) const
 111     {
 112         QList<ProjectBaseItem*> files;
 113         if( !folder )
 114             return files;
 115
 116         if( folder->url().equals( url, KUrl::CompareWithoutTrailingSlash ) )
 117         {
 118             files << folder;
 119         }
 120
 121         // Check top level files
 122         foreach( ProjectFileItem* file, folder->fileList() )
 123         {
 124             if( file->url() == url )
 125             {
 126                 files << file;
 127             }
 128         }
 129
 130         // Check top level targets
 131         foreach( ProjectTargetItem* target, folder->targetList() )
 132         {
 133             foreach( ProjectFileItem* file, target->fileList() )
 134             {
 135                 if( file->url() == url )
 136                 {
 137                     files << file;
 138                 }
 139             }
 140         }
 141
 142         foreach( ProjectFolderItem* top, folder->folderList() )
 143         {
 144             files += itemsForUrlInternal( url, top );
 145         }
 146         return files;
 147     }
 148     QList<ProjectBaseItem*> itemsForUrl( const KUrl& url ) const
 149     {
 150         // TODO: This is moderately efficient, but could be much faster with a
 151         // QHash<QString, ProjectFolderItem> member. Would it be worth it?
 152         KUrl u = topItem->url();
 153         if ( u.protocol() != url.protocol() || u.host() != url.host() )
 154             return QList<ProjectBaseItem*>();
 155
 156         return itemsForUrlInternal( url, topItem );
 157     }
 158
 159
 160     void importDone( KJob* )
 161     {
 162         Core::self()->projectControllerInternal()->projectImportingFinished( project );
 163     }
 164 };
 165
 166 Project::Project( QObject *parent )
 167         : IProject( parent )
 168         , d( new ProjectPrivate )
 169 {
 170     QDBusConnection::sessionBus().registerObject( "/org/kdevelop/Project", this, QDBusConnection::ExportScriptableSlots );
 171
 172     d->project = this;
 173     d->manager = 0;
 174     d->topItem = 0;
 175     d->tmp = 0;
 176     d->vcsPlugin = 0;
 177 }
 178
 179 Project::~Project()
 180 {
 181     delete d;
 182 }
 183
 184 QString Project::name() const
 185 {
 186     return d->name;
 187 }
 188
 189 QString Project::developerTempFile() const
 190 {
 191     return d->developerTempFile;
 192 }
 193
 194 QString Project::projectTempFile() const
 195 {
 196     return d->projectTempFile;
 197 }
 198
 199 KSharedConfig::Ptr Project::projectConfiguration() const
 200 {
 201     d->m_cfg->reparseConfiguration();
 202     return d->m_cfg;
 203 }
 204
 205 // void Project::setLocalFile( const KUrl& u )
 206 // {
 207 //     d->localFile = u;
 208 // }
 209
 210 // void Project::setGlobalFile( const KUrl& u )
 211 // {
 212 //     d->globalFile = u;
 213 // }
 214
 215 const KUrl Project::folder() const
 216 {
 217     return d->folder;
 218 }
 219
 220 void Project::reloadModel()
 221 {
 222     ProjectModel* model = Core::self()->projectController()->projectModel();
 223     model->removeRow( d->topItem->row() );
 224     IProjectFileManager* iface = d->manager->extension<IProjectFileManager>();
 225     if( iface )
 226     {
 227         d->topItem = iface->import( this );
 228         if( !d->topItem )
 229         {
 230             KMessageBox::sorry( Core::self()->uiControllerInternal()->defaultMainWindow(),
 231                                 i18n("Could not open project") );
 232             return;
 233         }
 234         d->topItem->setIcon();
 235         model->appendRow(d->topItem);
 236 //         model->insertRow( model->rowCount(), d->topItem );
 237         ImportProjectJob* importJob = new ImportProjectJob( d->topItem, iface );
 238         Core::self()->runController()->registerJob( importJob );
 239      }
 240 }
 241
 242 bool Project::open( const KUrl& projectFileUrl_ )
 243 {
 244     //Canonicalize the project url, because we do the same in many other cases with files,
 245     //so we must canonicalize the project url too.
 246     KUrl projectFileUrl = projectFileUrl_;
 247
 248     if ( projectFileUrl.isLocalFile() )
 249     {
 250         QString path = QFileInfo( projectFileUrl.toLocalFile() ).canonicalFilePath();
 251         if ( !path.isEmpty() )
 252             projectFileUrl.setPath( path );
 253     }
 254
 255     KIO::StatJob* statJob = KIO::stat( projectFileUrl, KIO::HideProgressInfo );
 256     if ( !statJob->exec() ) //be sync for right now
 257     {
 258         KMessageBox::sorry( Core::self()->uiControllerInternal()->defaultMainWindow(),
 259                             i18n( "Unable to load the project file %1",
 260                                   projectFileUrl.pathOrUrl() ) );
 261         return false;
 262     }
 263
 264     d->projectFileUrl = projectFileUrl;
 265     d->developerFileUrl = KUrl( projectFileUrl.directory( KUrl::AppendTrailingSlash ) );
 266     d->developerFileUrl.addPath(".kdev4");
 267     d->developerFileUrl.addPath( projectFileUrl.fileName() );
 268
 269     statJob = KIO::stat( d->developerFileUrl, KIO::HideProgressInfo );
 270     if( !statJob->exec() )
 271     {
 272         KUrl dir = KUrl( projectFileUrl.directory( KUrl::AppendTrailingSlash ) + ".kdev4");
 273         statJob = KIO::stat( dir, KIO::HideProgressInfo );
 274         if( !statJob->exec() )
 275         {
 276             KIO::SimpleJob* mkdirJob = KIO::mkdir( dir );
 277             if( !mkdirJob->exec() )
 278             {
 279                 KMessageBox::sorry(
 280                         Core::self()->uiController()->activeMainWindow(),
 281                         i18n("Unable to create hidden dir (%1) for developer file",
 282                         dir.pathOrUrl() )
 283                         );
 284                 return false;
 285             }
 286         }
 287     }
 288
 289     if( !KIO::NetAccess::download( d->projectFileUrl, d->projectTempFile,
 290                         Core::self()->uiController()->activeMainWindow() ) )
 291     {
 292         KMessageBox::sorry( Core::self()->uiController()->activeMainWindow(),
 293                             i18n("Unable to get project file: %1",
 294                             d->projectFileUrl.pathOrUrl() ) );
 295         return false;
 296
 297     }
 298
 299     statJob = KIO::stat( d->developerFileUrl, KIO::HideProgressInfo );
 300     if( !statJob->exec() || !KIO::NetAccess::download( d->developerFileUrl, d->developerTempFile,
 301             Core::self()->uiController()->activeMainWindow() ) )
 302     {
 303
 304         d->tmp = new KTemporaryFile();
 305         d->tmp->open();
 306         d->developerTempFile = d->tmp->fileName();
 307         d->tmp->close();
 308     }
 309
 310     kDebug() << "Creating KConfig object for project files" << d->developerTempFile << d->projectTempFile;
 311     d->m_cfg = KSharedConfig::openConfig( d->developerTempFile );
 312     d->m_cfg->addConfigSources( QStringList() << d->projectTempFile );
 313
 314     KConfigGroup projectGroup( d->m_cfg, "Project" );
 315
 316     d->name = projectGroup.readEntry( "Name", projectFileUrl.fileName() );
 317     d->folder = projectFileUrl.directory( KUrl::AppendTrailingSlash );
 318
 319     QString managerSetting = projectGroup.readEntry( "Manager", "KDevGenericManager" );
 320
 321     //Get our importer
 322     IPluginController* pluginManager = Core::self()->pluginController();
 323     d->manager = pluginManager->pluginForExtension( "org.kdevelop.IProjectFileManager", managerSetting );
 324     IProjectFileManager* iface = 0;
 325     if ( d->manager )
 326         iface = d->manager->extension<IProjectFileManager>();
 327     else
 328     {
 329         KMessageBox::sorry( Core::self()->uiControllerInternal()->defaultMainWindow(),
 330                             i18n( "Could not load project management plugin %1.",
 331                                   managerSetting ) );
 332         d->manager = 0;
 333         return false;
 334     }
 335     if ( d->manager && iface )
 336     {
 337 //         ProjectModel* model = Core::self()->projectController()->projectModel();
 338         d->topItem = iface->import( this );
 339         if( !d->topItem )
 340         {
 341             KMessageBox::sorry( Core::self()->uiControllerInternal()->defaultMainWindow(),
 342                                 i18n("Could not open project") );
 343             return false;
 344         }
 345         d->topItem->setIcon();
 346 //         model->insertRow( model->rowCount(), d->topItem );
 347         ImportProjectJob* importJob = new ImportProjectJob( d->topItem, iface );
 348         connect( importJob, SIGNAL( result( KJob* ) ), this, SLOT( importDone( KJob* ) ) );
 349         importJob->start(); //be asynchronous
 350     }
 351     else
 352     {
 353         KMessageBox::sorry( Core::self()->uiControllerInternal()->defaultMainWindow(),
 354                             i18n( "project importing plugin (%1) does not support the IProjectFileManager interface.", managerSetting ) );
 355         delete d->manager;
 356         d->manager = 0;
 357         return false;
 358     }
 359
 360     QString vcsPlugin = projectGroup.readEntry("VersionControlSupport", "");
 361     if( !vcsPlugin.isEmpty() )
 362     {
 363         d->vcsPlugin = pluginManager->pluginForExtension( "org.kdevelop.IBasicVersionControl", vcsPlugin );
 364     }
 365
 366     return true;
 367 }
 368
 369 void Project::close()
 370 {
 371     // unloaded by project controller, depending on shared count
 372 //     KPluginInfo* pluginInfo = Core::self()->pluginController()->pluginInfo( d->manager );
 373 //     if ( pluginInfo )
 374 //     {
 375 //         Core::self()->pluginController()->unloadPlugin( pluginInfo->pluginName() );
 376 //     }
 377
 378     //the manager plugin will be deleted in the plugin controller, so just set
 379     //the manager to zero.
 380 //     d->manager = 0;
 381     Core::self()->projectController()->projectModel()->removeRow( d->topItem->row() );
 382
 383     if( d->tmp )
 384     {
 385         d->tmp->close();
 386     }
 387
 388     if( !KIO::NetAccess::upload( d->developerTempFile, d->developerFileUrl,
 389                 Core::self()->uiController()->activeMainWindow() ) )
 390     {
 391         KMessageBox::sorry( Core::self()->uiController()->activeMainWindow(),
 392                     i18n("Could not store developer specific project configuration.\n"
 393                          "Attention: The project settings you changed will be lost."
 394                     ) );
 395     }
 396     delete d->tmp;
 397 }
 398
 399 bool Project::inProject( const KUrl& url ) const
 400 {
 401     if( url.isLocalFile() && QFileInfo( url.path() ).isFile() )
 402         return d->fileSet.contains( IndexedString( url ) );
 403     return ( !d->itemsForUrl( url ).isEmpty() );
 404 }
 405
 406 ProjectFileItem* Project::fileAt( int num ) const
 407 {
 408     QList<ProjectFileItem*> files;
 409     if ( d->topItem )
 410         files = d->recurseFiles( d->topItem );
 411
 412     if( !files.isEmpty() && num >= 0 && num < files.count() )
 413         return files.at( num );
 414     return 0;
 415 }
 416
 417 QList<ProjectFileItem *> KDevelop::Project::files() const
 418 {
 419     QList<ProjectFileItem *> files;
 420     if ( d->topItem )
 421         files = d->recurseFiles( d->topItem );
 422     return files;
 423 }
 424
 425 QList<ProjectFileItem*> Project::filesForUrl(const KUrl& url) const
 426 {
 427     QList<ProjectFileItem*> items;
 428     foreach(ProjectBaseItem* item,  d->itemsForUrl( url ) )
 429     {
 430         if( item->type() == ProjectBaseItem::File )
 431             items << dynamic_cast<ProjectFileItem*>( item );
 432     }
 433     return items;
 434 }
 435
 436 QList<ProjectFolderItem*> Project::foldersForUrl(const KUrl& url) const
 437 {
 438     QList<ProjectFolderItem*> items;
 439     foreach(ProjectBaseItem* item,  d->itemsForUrl( url ) )
 440     {
 441         if( item->type() == ProjectBaseItem::Folder )
 442             items << dynamic_cast<ProjectFolderItem*>( item );
 443     }
 444     return items;
 445 }
 446
 447 int Project::fileCount() const
 448 {
 449     QList<ProjectFileItem*> files;
 450     if ( d->topItem )
 451         files = d->recurseFiles( d->topItem );
 452     return files.count();
 453 }
 454
 455 KUrl Project::relativeUrl( const KUrl& absolute ) const
 456 {
 457     kDebug() << "Creating relative url between: " << folder() << absolute;
 458     return KUrl::relativeUrl( folder(), absolute );
 459 }
 460
 461 KUrl Project::urlRelativeToProject( const KUrl & relativeUrl ) const
 462 {
 463     if ( KUrl::isRelativeUrl( relativeUrl.toLocalFile() ) )
 464         return KUrl( folder(), relativeUrl.toLocalFile() );
 465
 466     return relativeUrl;
 467 }
 468
 469 IProjectFileManager* Project::projectFileManager() const
 470 {
 471     return d->manager->extension<IProjectFileManager>();
 472 }
 473
 474 IBuildSystemManager* Project::buildSystemManager() const
 475 {
 476     return d->manager->extension<IBuildSystemManager>();
 477 }
 478
 479 IPlugin* Project::managerPlugin() const
 480 {
 481   return d->manager;
 482 }
 483
 484 void Project::setManagerPlugin( IPlugin* manager )
 485 {
 486     d->manager = manager;
 487 }
 488
 489 // PersistentHash * Project::persistentHash() const
 490 // {
 491 //     return &d->persistentHash;
 492 // }
 493
 494 KUrl Project::projectFileUrl() const
 495 {
 496     return d->projectFileUrl;
 497 }
 498
 499 KUrl Project::developerFileUrl() const
 500 {
 501     return d->developerFileUrl;
 502 }
 503
 504 ProjectFolderItem* Project::projectItem() const
 505 {
 506     return d->topItem;
 507 }
 508
 509 IPlugin* Project::versionControlPlugin() const
 510 {
 511     return d->vcsPlugin;
 512 }
 513
 514
 515 void Project::addToFileSet( const IndexedString& file )
 516 {
 517     d->fileSet.insert( file );
 518 }
 519
 520 void Project::removeFromFileSet( const IndexedString& file )
 521 {
 522     d->fileSet.remove( file );
 523 }
 524
 525 QSet<IndexedString> Project::fileSet() const
 526 {
 527     return d->fileSet;
 528 }
 529
 530 }
 531
 532 #include "project.moc"
 533