plugins/teamwork/teamworkfoldermanager.cpp

   1 /***************************************************************************
   2   Copyright 2006 David Nolden <david.nolden.kdevelop@art-master.de>
   3 ***************************************************************************/
   4
   5 /***************************************************************************
   6  *                                                                         *
   7  *   This program is free software; you can redistribute it and/or modify  *
   8  *   it under the terms of the GNU General Public License as published by  *
   9  *   the Free Software Foundation; either version 2 of the License, or     *
  10  *   (at your option) any later version.                                   *
  11  *                                                                         *
  12  ***************************************************************************/
  13
  14 #include "teamworkfoldermanager.h"
  15 #include <interfaces/icore.h>
  16 #include "kdevteamworkplugin.h"
  17 #include <kio/netaccess.h>
  18 #include <krandom.h>
  19 #include <QStringList>
  20 #include <QFileInfo>
  21 #include <QFile>
  22 #include <QDateTime>
  23 #include <kdebug.h>
  24 #include <kurl.h>
  25
  26 /* Exclude this file from doublequote_chars check as krazy doesn't understand
  27 std::string*/
  28 //krazy:excludeall=doublequote_chars
  29
  30 TeamworkFolderManager* TeamworkFolderManager::m_self = 0;
  31
  32 KUrl TeamworkFolderManager::workspaceDirectory() {
  33   return m_self->m_workspaceDir;
  34 }
  35
  36 TeamworkFolderManager::TeamworkFolderManager( const KUrl& directory ) {
  37   m_self = this;
  38
  39   KUrl u = directory;
  40   u.cleanPath();
  41
  42   m_workspaceDir = u;
  43   u.addPath( ".teamwork" );
  44   u.cleanPath();
  45   m_teamworkDir = u;
  46 }
  47
  48 TeamworkFolderManager* TeamworkFolderManager::self() {
  49   return m_self;
  50 }
  51
  52 KUrl TeamworkFolderManager::teamworkAbsolute( const QString& subDirectory, const QString& subFolder ) {
  53   KUrl ret( self()->m_teamworkDir );
  54   ret.addPath( subFolder );
  55   if( subDirectory.startsWith( ret.toLocalFile() ) ) return subDirectory;
  56   ret.addPath( subDirectory );
  57   ret.cleanPath();
  58   return ret;
  59 }
  60
  61 KUrl TeamworkFolderManager::workspaceAbsolute( const QString& subDirectory, const QString& subFolder ) {
  62   KUrl ret( self()->m_workspaceDir );
  63   ret.addPath( subFolder );
  64   if( subDirectory.startsWith( ret.toLocalFile() ) ) return subDirectory;
  65   ret.addPath( subDirectory );
  66   ret.cleanPath();
  67   return ret;
  68 }
  69
  70 void TeamworkFolderManager::createTeamworkFolder() throw(QString) {
  71   KUrl ul = self()->m_workspaceDir;
  72
  73   ul.addPath( ".teamwork" );
  74   if ( !KIO::NetAccess::exists( ul, KIO::NetAccess::SourceSide, 0 ) )
  75     if( !KIO::NetAccess::mkdir( ul, 0 ) )
  76       throw QString( "could not create \"%1\"" ).arg( ul.prettyUrl() );
  77 }
  78
  79
  80 KUrl TeamworkFolderManager::createUniqueDirectory( const QString& subFolder, const QString& name, const QString& namePrefix, const QString& nameSuffix ) throw(QString) {
  81   if( self()->m_workspaceDir.isEmpty() )
  82     throw QString( "no teamwork-workspace-directory set" );
  83   KUrl ul = self()->m_workspaceDir;
  84
  85   ul.addPath( ".teamwork" );
  86   if ( !KIO::NetAccess::exists( ul, KIO::NetAccess::SourceSide, 0 ) )
  87     KIO::NetAccess::mkdir( ul, 0 );
  88
  89   if ( !KIO::NetAccess::exists( ul, KIO::NetAccess::SourceSide, 0 ) )
  90     throw QString( "could not create .teamwork-directory" );
  91
  92
  93   QStringList sub = subFolder.split( "/" );
  94   while( !sub.isEmpty() ) {
  95     ul.addPath( sub.front() );
  96     if ( !KIO::NetAccess::exists( ul, KIO::NetAccess::SourceSide, 0 ) )
  97       KIO::NetAccess::mkdir( ul, 0 );
  98
  99     if ( !KIO::NetAccess::exists( ul, KIO::NetAccess::SourceSide, 0 ) )
 100       throw QString( "could not create directory %1 directory" ).arg( ul.prettyUrl() );
 101
 102     sub.pop_front();
 103   }
 104
 105
 106   KUrl nu = ul;
 107   nu.addPath( namePrefix + name + nameSuffix );
 108   nu.cleanPath();
 109
 110   if( !KIO::NetAccess::exists( nu, KIO::NetAccess::SourceSide, 0 ) ){
 111     KIO::NetAccess::mkdir( nu, 0 );
 112
 113     if ( KIO::NetAccess::exists( nu, KIO::NetAccess::SourceSide, 0 ) )
 114       return nu;
 115   }
 116
 117     ///If the file exists try it with additional date/time
 118   nu = ul;
 119   nu.addPath( namePrefix + name + QDateTime::currentDateTime().toString( Qt::ISODate ) + nameSuffix );
 120
 121   nu.cleanPath();
 122   if( !KIO::NetAccess::exists( nu, KIO::NetAccess::SourceSide, 0 ) ) {
 123     KIO::NetAccess::mkdir( nu, 0 );
 124
 125     if ( KIO::NetAccess::exists( nu, KIO::NetAccess::SourceSide, 0 ) )
 126       return nu;
 127   }
 128
 129     ///If even this file exists, add a suffix behind the date
 130   for( int a = 0; a < 100; a++ ) {
 131     nu = ul;
 132     nu.addPath( namePrefix + QString("_%1_").arg( a ) + name + QDateTime::currentDateTime().toString( Qt::ISODate ) + nameSuffix );
 133     nu.cleanPath();
 134     if( !KIO::NetAccess::exists( nu, KIO::NetAccess::SourceSide, 0 ) ){
 135       KIO::NetAccess::mkdir( nu, 0 );
 136
 137       if ( KIO::NetAccess::exists( nu, KIO::NetAccess::SourceSide, 0 ) )
 138         return nu;
 139     }
 140   }
 141
 142   throw QString( "failed to allocate filename for %1" ).arg( name + "." + nameSuffix );
 143 }
 144
 145 KUrl TeamworkFolderManager::createUniqueFile( const QString& subFolder, const QString& extension, const QString& name, const QString& namePrefix, const QString& nameSuffix ) throw(QString) {
 146   if( self()->m_workspaceDir.isEmpty() )
 147     throw QString( "no teamwork-workspace-directory set" );
 148     KUrl ul = self()->m_workspaceDir;
 149
 150     ul.addPath( ".teamwork" );
 151     if ( !KIO::NetAccess::exists( ul, KIO::NetAccess::SourceSide, 0 ) )
 152       KIO::NetAccess::mkdir( ul, 0 );
 153
 154     if ( !KIO::NetAccess::exists( ul, KIO::NetAccess::SourceSide, 0 ) )
 155       throw QString( "could not create .teamwork-directory" );
 156
 157
 158     QStringList sub = subFolder.split( "/" );
 159     while( !sub.isEmpty() ) {
 160       ul.addPath( sub.front() );
 161       if ( !KIO::NetAccess::exists( ul, KIO::NetAccess::SourceSide, 0 ) )
 162         KIO::NetAccess::mkdir( ul, 0 );
 163
 164       if ( !KIO::NetAccess::exists( ul, KIO::NetAccess::SourceSide, 0 ) )
 165         throw QString( "could not create directory %1 directory" ).arg( ul.prettyUrl() );
 166
 167       sub.pop_front();
 168     }
 169
 170
 171     KUrl nu = ul;
 172     nu.addPath( namePrefix + name + nameSuffix + "." + extension );
 173
 174     nu.cleanPath();
 175     if( !KIO::NetAccess::exists( nu, KIO::NetAccess::SourceSide, 0 ) ){
 176       if( createFile( nu ) )
 177         return nu;
 178     }
 179
 180     ///If the file exists try it with additional date/time
 181     nu = ul;
 182     nu.addPath( namePrefix + name + QDateTime::currentDateTime().toString( Qt::ISODate ) + nameSuffix + "." + extension );
 183
 184     nu.cleanPath();
 185     if( !KIO::NetAccess::exists( nu, KIO::NetAccess::SourceSide, 0 ) ) {
 186       if( createFile( nu ) )
 187         return nu;
 188     }
 189
 190     ///If even this file exists, add a suffix behind the date
 191     for( int a = 0; a < 100; a++ ) {
 192       nu = ul;
 193       nu.addPath( namePrefix + QString("_%1_").arg( a ) + name + QDateTime::currentDateTime().toString( Qt::ISODate ) + nameSuffix + "." + extension );
 194       nu.cleanPath();
 195       if( !KIO::NetAccess::exists( nu, KIO::NetAccess::SourceSide, 0 ) ){
 196       if( createFile( nu ) )
 197         return nu;
 198       }
 199     }
 200
 201     throw QString( "failed to allocate filename for %1" ).arg( name + "." + nameSuffix );
 202 }
 203
 204 KUrl TeamworkFolderManager::createUniqueFile( const QString& subFolder, const QString& fileName, const QString& namePrefix, const QString& nameSuffix ) throw(QString) {
 205   QFileInfo i( fileName );
 206   KUrl u( subFolder );
 207   u.addPath( i.path() );
 208   return createUniqueFile( u.toLocalFile(), i.completeSuffix(), i.baseName(), namePrefix, nameSuffix );
 209 }
 210
 211 void TeamworkFolderManager::registerTempItem( const KUrl& u ) {
 212   if( u.isRelative() )
 213     self()->m_tempItems[teamworkAbsolute(u.toLocalFile()).pathOrUrl()] = true;
 214   else
 215     self()->m_tempItems[u.pathOrUrl()] = true;
 216 }
 217
 218 QString TeamworkFolderManager::teamworkRelative( const KUrl& url, const QString& subfolder ) {
 219   KUrl u = self()->m_teamworkDir;
 220   u.addPath( subfolder );
 221   u.adjustPath( KUrl::AddTrailingSlash );
 222   return KUrl::relativeUrl( u, url );
 223 }
 224
 225 QString TeamworkFolderManager::workspaceRelative( const KUrl& url, const QString& subfolder ) {
 226   KUrl u = self()->m_workspaceDir;
 227   u.addPath( subfolder );
 228   u.adjustPath( KUrl::AddTrailingSlash );
 229   //kDebug(9500) << "workspaceRelative(" << url << "," << subfolder << ") called. Worspace:" << self()->m_workspaceDir << "base:" << u << "result:" << KUrl::relativeUrl( u, url );
 230   return KUrl::relativeUrl( u, url );
 231 }
 232
 233 TeamworkFolderManager::~TeamworkFolderManager() {
 234   for( QMap< QString, bool >::iterator it = m_tempItems.begin();it != m_tempItems.end(); ++it ) {
 235     ///First, make sure that the file is really a subfolder of the .teamwork-directory
 236     KUrl f(  it.key() );
 237     f.cleanPath();
 238     if( (f.path()).startsWith( m_teamworkDir.path(KUrl::AddTrailingSlash) ) && (f.pathOrUrl()).startsWith( m_teamworkDir.pathOrUrl() ) ) {
 239       if( ! KIO::NetAccess::del( f, 0 ) )
 240         kDebug(9500) << "TeamworkFolderManager error: File" << f.prettyUrl() << "could not be deleted";
 241     } else {
 242       kDebug(9500) << "TeamworkFolderManager error: File" << f.prettyUrl() << "was registered as temporary file, but is not in folder" << m_teamworkDir;
 243     }
 244   }
 245   m_tempItems.clear();
 246 }
 247
 248 ///@todo use netaccess!
 249 bool TeamworkFolderManager::createFile( const KUrl& url ) {
 250   QFile f( url.path() );
 251   if( f.open(QIODevice::WriteOnly) )
 252     return true;
 253   else
 254     return false;
 255 }
 256
 257
 258 // kate: space-indent on; indent-width 2; tab-width 2; replace-tabs on