summaryrefslogtreecommitdiff
path: root/kpimutils/kfileio.cpp
blob: 25846bcfb9f0b3e157d638f636b749d02c1a577f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
/*
  Copyright (c) 2005 Tom Albers <tomalbers@kde.nl>
  Copyright (c) 1997-1999 Stefan Taferner <taferner@kde.org>

  This library is free software; you can redistribute it and/or modify it
  under the terms of the GNU Library General Public License as published by
  the Free Software Foundation; either version 2 of the License, or (at your
  option) any later version.

  This library 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 Library General Public
  License for more details.

  You should have received a copy of the GNU Library General Public License
  along with this library; see the file COPYING.LIB.  If not, write to the
  Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  02110-1301, USA.
*/

#include "kfileio.h"
#include "kpimutils_export.h"

#include <KDebug>
#include <KLocale>
#include <KMessageBox>
#include <KStandardGuiItem>
#include <kde_file.h> //krazy:exclude=camelcase

#include <QDir>
#include <QByteArray>
#include <QWidget>
#include <QFile>
#include <QFileInfo>

#include <sys/stat.h>
#include <sys/types.h>
#include <assert.h>

namespace KPIMUtils {

//-----------------------------------------------------------------------------
static void msgDialog( const QString &msg )
{
  KMessageBox::sorry( 0, msg, i18n( "File I/O Error" ) );
}

//-----------------------------------------------------------------------------
QByteArray kFileToByteArray( const QString &aFileName, bool aEnsureNL,
                             bool aVerbose )
{
  QByteArray result;
  QFileInfo info( aFileName );
  unsigned int readLen;
  unsigned int len = info.size();
  QFile file( aFileName );

  //assert(aFileName!=0);
  if( aFileName.isEmpty() ) {
    return "";
  }

  if ( !info.exists() ) {
    if ( aVerbose ) {
      msgDialog( i18n( "The specified file does not exist:\n%1", aFileName ) );
    }
    return QByteArray();
  }
  if ( info.isDir() ) {
    if ( aVerbose ) {
      msgDialog( i18n( "This is a folder and not a file:\n%1", aFileName ) );
    }
    return QByteArray();
  }
  if ( !info.isReadable() ) {
    if ( aVerbose ) {
      msgDialog( i18n( "You do not have read permissions to the file:\n%1", aFileName ) );
    }
    return QByteArray();
  }
  if ( len <= 0 ) {
    return QByteArray();
  }

  if ( !file.open( QIODevice::Unbuffered|QIODevice::ReadOnly ) ) {
    if ( aVerbose ) {
      switch( file.error() ) {
      case QFile::ReadError:
        msgDialog( i18n( "Could not read file:\n%1", aFileName ) );
        break;
      case QFile::OpenError:
        msgDialog( i18n( "Could not open file:\n%1", aFileName ) );
        break;
      default:
        msgDialog( i18n( "Error while reading file:\n%1", aFileName ) );
      }
    }
    return QByteArray();
  }

  result.resize( len + int( aEnsureNL ) );
  readLen = file.read( result.data(), len );
  if ( aEnsureNL ) {
    if ( result[readLen-1] != '\n' ) {
      result[readLen++] = '\n';
      len++;
    } else {
      result.truncate( len );
    }
  }

  if ( readLen < len ) {
    QString msg = i18np( "Could only read 1 byte of %2.",
                         "Could only read %1 bytes of %2.",
                         readLen, len );
    msgDialog( msg );
    result.truncate( readLen );
  }

  return result;
}

//-----------------------------------------------------------------------------
bool kByteArrayToFile( const QByteArray &aBuffer, const QString &aFileName,
                       bool aAskIfExists, bool aBackup, bool aVerbose )
{
  // TODO: use KSaveFile
  QFile file( aFileName );

  //assert(aFileName!=0);
  if( aFileName.isEmpty() ) {
    return false;
  }

  if ( file.exists() ) {
    if ( aAskIfExists ) {
      QString str;
      str = i18n( "File %1 exists.\nDo you want to replace it?", aFileName );
      const int rc =
        KMessageBox::warningContinueCancel( 0, str, i18n( "Save to File" ),
                                            KGuiItem( i18n( "&Replace" ) ) );
      if ( rc != KMessageBox::Continue ) {
        return false;
      }
    }
    if ( aBackup ) {
      // make a backup copy
      // TODO: use KSaveFile::backupFile()
      QString bakName = aFileName;
      bakName += '~';
      QFile::remove(bakName);
      if ( !QDir::current().rename( aFileName, bakName ) ) {
	// failed to rename file
        if ( !aVerbose ) {
          return false;
        }
        const int rc =
          KMessageBox::warningContinueCancel(
            0,
            i18n( "Failed to make a backup copy of %1.\nContinue anyway?", aFileName ),
            i18n( "Save to File" ), KStandardGuiItem::save() );

        if ( rc != KMessageBox::Continue ) {
          return false;
        }
      }
    }
  }

  if ( !file.open( QIODevice::Unbuffered|QIODevice::WriteOnly|QIODevice::Truncate ) ) {
    if ( aVerbose ) {
      switch( file.error() ) {
      case QFile::WriteError:
        msgDialog( i18n( "Could not write to file:\n%1", aFileName ) );
        break;
      case QFile::OpenError:
        msgDialog( i18n( "Could not open file for writing:\n%1", aFileName ) );
        break;
      default:
        msgDialog( i18n( "Error while writing file:\n%1", aFileName ) );
      }
    }
    return false;
  }

  const int writeLen = file.write( aBuffer.data(), aBuffer.size() );

  if ( writeLen < 0 ) {
    if ( aVerbose ) {
      msgDialog( i18n( "Could not write to file:\n%1", aFileName ) );
    }
    return false;
  } else if ( writeLen < aBuffer.size() ) {
    QString msg = i18np( "Could only write 1 byte of %2.",
                         "Could only write %1 bytes of %2.",
                         writeLen, aBuffer.size() );
    if ( aVerbose ) {
      msgDialog( msg );
    }
    return false;
  }

  return true;
}

QString checkAndCorrectPermissionsIfPossible( const QString &toCheck,
                                              const bool recursive,
                                              const bool wantItReadable,
                                              const bool wantItWritable )
{
  // First we have to find out which type the toCheck is. This can be
  // a directory (follow if recursive) or a file (check permissions).
  // Symlinks are followed as expected.
  QFileInfo fiToCheck(toCheck);
  fiToCheck.setCaching(false);
  QByteArray toCheckEnc = QFile::encodeName( toCheck );
  QString error;
  KDE_struct_stat statbuffer;

  if ( !fiToCheck.exists() ) {
    error.append( i18n( "%1 does not exist", toCheck ) + '\n' );
  }

  // check the access bit of a folder.
  if ( fiToCheck.isDir() ) {
    if ( KDE_stat( toCheckEnc,&statbuffer ) != 0 ) {
      kDebug() << "wantItA: Can't read perms of" << toCheck;
    }
    QDir g( toCheck );
    if ( !g.isReadable() ) {
      if ( chmod( toCheckEnc, statbuffer.st_mode + S_IXUSR ) != 0 ) {
        error.append( i18n( "%1 is not accessible and that is "
                            "unchangeable.", toCheck ) + '\n' );
      } else {
        kDebug() << "Changed access bit for" << toCheck;
      }
    }
  }

  // For each file or folder  we can check if the file is readable
  // and writable, as requested.
  if ( fiToCheck.isFile() || fiToCheck.isDir() ) {

    if ( !fiToCheck.isReadable() && wantItReadable ) {
      // Get the current permissions. No need to do anything with an
      // error, it will het added to errors anyhow, later on.
      if ( KDE_stat( toCheckEnc,&statbuffer ) != 0 ) {
        kDebug() << "wantItR: Can't read perms of" << toCheck;
      }

      // Lets try changing it.
      if ( chmod( toCheckEnc, statbuffer.st_mode + S_IRUSR ) != 0 ) {
        error.append( i18n( "%1 is not readable and that is unchangeable.",
                            toCheck ) + '\n' );
      } else {
        kDebug() << "Changed the read bit for" << toCheck;
      }
    }

    if ( !fiToCheck.isWritable() && wantItWritable ) {
      // Gets the current persmissions. Needed because it can be changed
      // curing previous operation.
      if ( KDE_stat( toCheckEnc,&statbuffer ) != 0 ) {
        kDebug() << "wantItW: Can't read perms of" << toCheck;
      }

      // Lets try changing it.
      if ( chmod ( toCheckEnc, statbuffer.st_mode + S_IWUSR ) != 0 ) {
        error.append( i18n( "%1 is not writable and that is unchangeable.", toCheck ) + '\n' );
      } else {
        kDebug() << "Changed the write bit for" << toCheck;
      }
    }
  }

  // If it is a folder and recursive is true, then we check the contents of
  // the folder.
  if ( fiToCheck.isDir() && recursive ){
    QDir g( toCheck );
    // First check if the folder is readable for us. If not, we get
    // some ugly crashes.
    if ( !g.isReadable() ){
      error.append( i18n( "Folder %1 is inaccessible.", toCheck ) + '\n' );
    } else {
      foreach ( const QFileInfo &fi, g.entryInfoList() ) {
        QString newToCheck = toCheck + '/' + fi.fileName();
        QFileInfo fiNewToCheck(newToCheck);
        if ( fi.fileName() != "." && fi.fileName() != ".." ) {
          error.append (
            checkAndCorrectPermissionsIfPossible( newToCheck, recursive,
                                                  wantItReadable, wantItWritable ) );
        }
      }
    }
  }
  return error;
}

bool checkAndCorrectPermissionsIfPossibleWithErrorHandling( QWidget *parent,
                                                            const QString &toCheck,
                                                            const bool recursive,
                                                            const bool wantItReadable,
                                                            const bool wantItWritable )
{
  QString error =
    checkAndCorrectPermissionsIfPossible( toCheck, recursive, wantItReadable, wantItWritable );

  // There is no KMessageBox with Retry, Cancel and Details.
  // so, I can't provide a functionality to recheck. So it now
  // it is just a warning.
  if ( !error.isEmpty() ) {
    kDebug() << "checkPermissions found:" << error;
    KMessageBox::detailedSorry( parent,
                                i18n( "Some files or folders do not have the "
                                      "necessary permissions, please correct "
                                      "them manually." ),
                                error, i18n( "Permissions Check" ), 0 );
    return false;
  } else {
    return true;
  }
}

bool removeDirAndContentsRecursively( const QString & path )
{
  bool success = true;

  QDir d;
  d.setPath( path );
  d.setFilter( QDir::Files | QDir::Dirs | QDir::Hidden | QDir::NoSymLinks );

  QFileInfoList list = d.entryInfoList();

  Q_FOREACH ( const QFileInfo &fi, list ) {
    if ( fi.isDir() ) {
      if ( fi.fileName() != "." && fi.fileName() != ".." ) {
        success = success && removeDirAndContentsRecursively( fi.absoluteFilePath() );
      }
    } else {
      success = success && d.remove( fi.absoluteFilePath() );
    }
  }

  if ( success ) {
    success = success && d.rmdir( path ); // nuke ourselves, we should be empty now
  }
  return success;
}

}