src/jobs/widget_install/task_file_manipulation.cpp

   1 /*
   2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  *    Licensed under the Apache License, Version 2.0 (the "License");
   5  *    you may not use this file except in compliance with the License.
   6  *    You may obtain a copy of the License at
   7  *
   8  *        http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  *    Unless required by applicable law or agreed to in writing, software
  11  *    distributed under the License is distributed on an "AS IS" BASIS,
  12  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  *    See the License for the specific language governing permissions and
  14  *    limitations under the License.
  15  */
  16 /**
  17  * @file    task_db_update.cpp
  18  * @author  Lukasz Wrzosek(l.wrzosek@samsung.com)
  19  * @version 1.0
  20  * @brief   Implementation file for installer task database updating
  21  */
  22 #include <unistd.h>
  23 #include <sys/stat.h>
  24 #include <dirent.h>
  25 #include <widget_install/task_file_manipulation.h>
  26 #include <widget_install/job_widget_install.h>
  27 #include <widget_install/widget_install_errors.h>
  28 #include <widget_install/widget_install_context.h>
  29 #include <widget_install/directory_api.h>
  30 #include <dpl/utils/wrt_utility.h>
  31 #include <dpl/foreach.h>
  32 #include <dpl/log/log.h>
  33 #include <dpl/assert.h>
  34 #include <dpl/errno_string.h>
  35 #include <dpl/utils/folder_size.h>
  36 #include <dpl/wrt-dao-ro/global_config.h>
  37 #include <string>
  38 #include <fstream>
  39 #include <widget_install_to_external.h>
  40
  41 #define WEBAPP_DEFAULT_UID  5000
  42 #define WEBAPP_DEFAULT_GID  5000
  43
  44 namespace {
  45 const mode_t PRIVATE_STORAGE_MODE = 0700;
  46 const mode_t SHARED_STORAGE_MODE = 0755;
  47 }
  48
  49 using namespace WrtDB;
  50
  51 namespace {
  52 const char* GLIST_RES_DIR = "res";
  53
  54 bool _FolderCopy(std::string source, std::string dest)
  55 {
  56     DIR* dir = opendir(source.c_str());
  57     if (NULL == dir) {
  58         return false;
  59     }
  60
  61     struct dirent dEntry;
  62     struct dirent *dEntryResult;
  63     int return_code;
  64
  65     do {
  66         struct stat statInfo;
  67         return_code = readdir_r(dir, &dEntry, &dEntryResult);
  68         if (dEntryResult != NULL && return_code == 0) {
  69             std::string fileName = dEntry.d_name;
  70             std::string fullName = source + "/" + fileName;
  71
  72             if (stat(fullName.c_str(), &statInfo) != 0) {
  73                 closedir(dir);
  74                 return false;
  75             }
  76
  77             if (S_ISDIR(statInfo.st_mode)) {
  78                 if (("." == fileName) || (".." == fileName)) {
  79                     continue;
  80                 }
  81                 std::string destFolder = dest + "/" + fileName;
  82                 WrtUtilMakeDir(destFolder);
  83
  84                 if (!_FolderCopy(fullName, destFolder)) {
  85                     closedir(dir);
  86                     return false;
  87                 }
  88             }
  89
  90             std::string destFile = dest + "/" + fileName;
  91             std::ifstream infile(fullName);
  92             std::ofstream outfile(destFile);
  93             outfile << infile.rdbuf();
  94             outfile.close();
  95             infile.close();
  96         }
  97     } while (dEntryResult != NULL && return_code == 0);
  98     closedir(dir);
  99     return true;
 100 }
 101
 102 void changeOwnerForDirectory(std::string storagePath, mode_t mode) {
 103     if (euidaccess(storagePath.c_str(), F_OK) != 0) {
 104         if (!WrtUtilMakeDir(storagePath, mode)) {
 105             LogError("Failed to create directory : " << storagePath);
 106             ThrowMsg(Jobs::WidgetInstall::Exceptions::FileOperationFailed,
 107                      "Failed to create directory : " << storagePath);
 108         }
 109         // '5000' is default uid, gid for applications.
 110         // So installed applications should be launched as process of uid
 111         // '5000'.
 112         // the process can access private directory 'data' of itself.
 113         if (chown(storagePath.c_str(),
 114                   WEBAPP_DEFAULT_UID,
 115                   WEBAPP_DEFAULT_GID) != 0)
 116         {
 117             ThrowMsg(Jobs::WidgetInstall::Exceptions::FileOperationFailed,
 118                      "Chown to invaild user");
 119         }
 120     } else if (euidaccess(storagePath.c_str(), W_OK | R_OK | X_OK) == 0) {
 121         LogDebug(storagePath << " already exists.");
 122         // Even if private directory already is created, private dircetory
 123         // should change owner.
 124         if (chown(storagePath.c_str(),
 125                   WEBAPP_DEFAULT_UID,
 126                   WEBAPP_DEFAULT_GID) != 0)
 127         {
 128             ThrowMsg(Jobs::WidgetInstall::Exceptions::FileOperationFailed,
 129                      "Chown to invaild user");
 130         }
 131         if (chmod(storagePath.c_str(), mode) != 0) {
 132             ThrowMsg(Jobs::WidgetInstall::Exceptions::FileOperationFailed,
 133                      "chmod to 0700");
 134         }
 135     } else {
 136         ThrowMsg(Jobs::WidgetInstall::Exceptions::FileOperationFailed,
 137                  "No access to private storage.");
 138     }
 139 }
 140 }
 141
 142 namespace Jobs {
 143 namespace WidgetInstall {
 144 TaskFileManipulation::TaskFileManipulation(InstallerContext& context) :
 145     DPL::TaskDecl<TaskFileManipulation>(this),
 146     m_context(context),
 147     m_extHandle(NULL)
 148 {
 149     AddStep(&TaskFileManipulation::StartStep);
 150     if (INSTALL_LOCATION_TYPE_EXTERNAL !=
 151             m_context.locationType)
 152     {
 153         AddStep(&TaskFileManipulation::StepCreateDirs);
 154         if (m_context.mode.extension != InstallMode::ExtensionType::DIR)
 155         {
 156             AddStep(&TaskFileManipulation::StepRenamePath);
 157             AddAbortStep(&TaskFileManipulation::StepAbortRenamePath);
 158         }
 159         AddStep(&TaskFileManipulation::StepCreatePrivateStorageDir);
 160         AddStep(&TaskFileManipulation::StepCreateSharedFolder);
 161         AddStep(&TaskFileManipulation::StepLinkForPreload);
 162
 163     } else {
 164         AddStep(&TaskFileManipulation::StepPrepareExternalDir);
 165         AddStep(&TaskFileManipulation::StepInstallToExternal);
 166         AddStep(&TaskFileManipulation::StepCreatePrivateStorageDir);
 167         AddStep(&TaskFileManipulation::StepCreateSharedFolder);
 168
 169         AddAbortStep(&TaskFileManipulation::StepAbortCreateExternalDir);
 170     }
 171     AddStep(&TaskFileManipulation::EndStep);
 172 }
 173
 174 void TaskFileManipulation::StepCreateDirs()
 175 {
 176     std::string widgetPath;
 177
 178     widgetPath = m_context.locations->getPackageInstallationDir();
 179
 180     std::string widgetBinPath = m_context.locations->getBinaryDir();
 181     std::string widgetSrcPath = m_context.locations->getSourceDir();
 182
 183     WrtUtilMakeDir(widgetPath);
 184
 185     // If package type is widget with osp service, we don't need to make bin
 186     // and src directory
 187     if (m_context.widgetConfig.packagingType == PKG_TYPE_HYBRID_WEB_APP) {
 188         LogDebug("Doesn't need to create resource directory");
 189     } else {
 190         LogDebug("Create resource directory");
 191         WrtUtilMakeDir(widgetBinPath);
 192         WrtUtilMakeDir(widgetSrcPath);
 193         if (m_context.mode.installTime == InstallMode::InstallTime::PRELOAD) {
 194             std::string userWidgetDir = m_context.locations->getUserDataRootDir();
 195             WrtUtilMakeDir(userWidgetDir);
 196         }
 197     }
 198
 199     m_context.job->UpdateProgress(
 200         InstallerContext::INSTALL_DIR_CREATE,
 201         "Widget Directory Created");
 202 }
 203
 204 void TaskFileManipulation::StepCreatePrivateStorageDir()
 205 {
 206     std::string storagePath = m_context.locations->getPrivateStorageDir();
 207     LogDebug("Create private storage directory : " <<
 208             m_context.locations->getPrivateStorageDir());
 209
 210     changeOwnerForDirectory(storagePath, PRIVATE_STORAGE_MODE);
 211
 212     if (m_context.isUpdateMode) { //update
 213         std::string backData = m_context.locations->getBackupPrivateDir();
 214         LogDebug("copy private storage " << backData << " to " << storagePath);
 215         if (!DirectoryApi::DirectoryCopy(backData, storagePath)) {
 216             LogError("Failed to rename " << backData << " to " << storagePath);
 217             ThrowMsg(Exceptions::BackupFailed,
 218                     "Error occurs copy private strage files");
 219         }
 220     }
 221
 222     std::string tempStoragePath = m_context.locations->getPrivateTempStorageDir();
 223     LogDebug("Create temp private storage directory : " << tempStoragePath);
 224     changeOwnerForDirectory(tempStoragePath, PRIVATE_STORAGE_MODE);
 225 }
 226
 227 void TaskFileManipulation::StepRenamePath()
 228 {
 229     std::string instDir;
 230
 231     if (m_context.widgetConfig.packagingType == PKG_TYPE_HYBRID_WEB_APP) {
 232         instDir = m_context.locations->getPackageInstallationDir();
 233     } else {
 234         instDir = m_context.locations->getSourceDir();
 235     }
 236
 237     LogDebug("Copy file from temp directory to " << instDir);
 238     if (!WrtUtilRemove(instDir)) {
 239         ThrowMsg(Exceptions::RemovingFolderFailure,
 240                  "Error occurs during removing existing folder");
 241     }
 242
 243     if (!(rename(m_context.locations->getTemporaryPackageDir().c_str(),
 244                  instDir.c_str()) == 0))
 245     {
 246         ThrowMsg(Exceptions::FileOperationFailed,
 247                  "Error occurs during renaming widget folder");
 248     }
 249     m_context.job->UpdateProgress(
 250         InstallerContext::INSTALL_RENAME_PATH,
 251         "Widget Rename path Finished");
 252 }
 253
 254 void TaskFileManipulation::StepLinkForPreload()
 255 {
 256     if (m_context.mode.rootPath == InstallMode::RootPath::RO) {
 257         std::string optRes = m_context.locations->getUserDataRootDir() +
 258             WrtDB::GlobalConfig::GetWidgetResPath();
 259         std::string usrRes = m_context.locations->getPackageInstallationDir() +
 260             WrtDB::GlobalConfig::GetWidgetResPath();
 261
 262         if (0 != access(optRes.c_str(), F_OK)) {
 263             LogDebug("Make symbolic name for preaload app" <<
 264                     usrRes << " to " << optRes);
 265
 266             if (symlink(usrRes.c_str(), optRes.c_str()) != 0)
 267             {
 268                 int error = errno;
 269                 if (error)
 270                     LogPedantic("Failed to make a symbolic name for a file "
 271                             << "[" <<  DPL::GetErrnoString(error) << "]");
 272                 ThrowMsg(Exceptions::FileOperationFailed,
 273                         "Symbolic link creating is not done.");
 274             }
 275         }
 276
 277         /* link for data directory */
 278         std::string storagePath = m_context.locations->getPrivateStorageDir();
 279         std::string dataDir = m_context.locations->getPackageInstallationDir() +
 280             "/" + WrtDB::GlobalConfig::GetWidgetPrivateStoragePath();
 281         if (0 != access(dataDir.c_str(), F_OK)) {
 282             LogDebug("Make symbolic name for preaload app " <<
 283                     storagePath << " to " << dataDir);
 284
 285             if (symlink(storagePath.c_str(), dataDir.c_str()) != 0)
 286             {
 287                 int error = errno;
 288                 if (error)
 289                     LogPedantic("Failed to make a symbolic name for a file "
 290                             << "[" <<  DPL::GetErrnoString(error) << "]");
 291                 ThrowMsg(Exceptions::FileOperationFailed,
 292                         "Symbolic link creating is not done.");
 293             }
 294             changeOwnerForDirectory(dataDir, PRIVATE_STORAGE_MODE);
 295         }
 296
 297         if (m_context.widgetConfig.packagingType != PKG_TYPE_HYBRID_WEB_APP) {
 298             std::string widgetBinPath = m_context.locations->getBinaryDir();
 299             std::string userBinPath = m_context.locations->getUserBinaryDir();
 300             LogDebug("Make symbolic link for preload app " << widgetBinPath <<
 301                     " to " << userBinPath);
 302             if (symlink(widgetBinPath.c_str(), userBinPath.c_str()) != 0)
 303             {
 304                 int error = errno;
 305                 if (error)
 306                     LogPedantic("Failed to make a symbolic name for a file "
 307                             << "[" <<  DPL::GetErrnoString(error) << "]");
 308                 ThrowMsg(Exceptions::FileOperationFailed,
 309                         "Symbolic link creating is not done.");
 310             }
 311
 312         }
 313     }
 314 }
 315
 316 void TaskFileManipulation::StepAbortRenamePath()
 317 {
 318     LogDebug("[Rename Widget Path] Aborting.... (Rename path)");
 319     std::string widgetPath;
 320     widgetPath = m_context.locations->getPackageInstallationDir();
 321     if (!WrtUtilRemove(widgetPath)) {
 322         LogError("Error occurs during removing existing folder");
 323     }
 324     // Remove user data directory if preload web app.
 325     std::string userData = m_context.locations->getUserDataRootDir();
 326     if (0 == access(userData.c_str(), F_OK)) {
 327         if (!WrtUtilRemove(userData)) {
 328             LogError("Error occurs during removing user data directory");
 329         }
 330     }
 331
 332     LogDebug("Rename widget path sucessful!");
 333 }
 334
 335 void TaskFileManipulation::StepPrepareExternalDir()
 336 {
 337     LogDebug("Step prepare to install in exernal directory");
 338     Try {
 339         std::string pkgid =
 340             DPL::ToUTF8String(m_context.widgetConfig.tzPkgid);
 341
 342         WidgetInstallToExtSingleton::Instance().initialize(pkgid);
 343
 344         size_t totalSize =
 345             Utils::getFolderSize(m_context.locations->getTemporaryPackageDir());
 346
 347         int folderSize = (int)(totalSize / (1024 * 1024)) + 1;
 348
 349         GList *list = NULL;
 350         app2ext_dir_details* dirDetail = NULL;
 351
 352         dirDetail = (app2ext_dir_details*) calloc(1,
 353                 sizeof(
 354                     app2ext_dir_details));
 355         if (NULL == dirDetail) {
 356             ThrowMsg(Exceptions::ErrorExternalInstallingFailure,
 357                     "error in app2ext");
 358         }
 359         dirDetail->name = strdup(GLIST_RES_DIR);
 360         dirDetail->type = APP2EXT_DIR_RO;
 361         list = g_list_append(list, dirDetail);
 362
 363         if (m_context.isUpdateMode) {
 364             WidgetInstallToExtSingleton::Instance().preUpgrade(list,
 365                                                                folderSize);
 366         } else {
 367             WidgetInstallToExtSingleton::Instance().preInstallation(list,
 368                                                                     folderSize);
 369         }
 370         free(dirDetail);
 371         g_list_free(list);
 372
 373         /* make bin directory */
 374         std::string widgetBinPath = m_context.locations->getBinaryDir();
 375         WrtUtilMakeDir(widgetBinPath);
 376     }
 377     Catch(WidgetInstallToExt::Exception::ErrorInstallToExt)
 378     {
 379         ReThrowMsg(Exceptions::ErrorExternalInstallingFailure,
 380                    "Error during \
 381                 create external folder ");
 382     }
 383 }
 384
 385 void TaskFileManipulation::StepInstallToExternal()
 386 {
 387     LogDebug("StepInstallExternal");
 388     if (!WrtUtilMakeDir(m_context.locations->getSourceDir())) {
 389         ThrowMsg(Exceptions::ErrorExternalInstallingFailure,
 390                  "To make src \
 391                 directory failed");
 392     }
 393
 394     LogDebug("Resource move to external storage " <<
 395              m_context.locations->getSourceDir());
 396     if (!_FolderCopy(m_context.locations->getTemporaryPackageDir(),
 397                      m_context.locations->getSourceDir()))
 398     {
 399         ThrowMsg(Exceptions::ErrorExternalInstallingFailure,
 400                  "Error occurs during renaming widget folder");
 401     }
 402 }
 403
 404 void TaskFileManipulation::StepAbortCreateExternalDir()
 405 {
 406     LogError("Abort StepAbortCreateExternalDir");
 407     if (m_context.isUpdateMode) {
 408         WidgetInstallToExtSingleton::Instance().postUpgrade(false);
 409     } else {
 410         WidgetInstallToExtSingleton::Instance().postInstallation(false);
 411     }
 412     WidgetInstallToExtSingleton::Instance().deinitialize();
 413 }
 414
 415 void TaskFileManipulation::StepCreateSharedFolder()
 416 {
 417     LogDebug("StepCreateSharedFolder");
 418     std::string sharedPath = m_context.locations->getSharedRootDir();
 419     LogDebug("Create shared directory : " <<
 420             m_context.locations->getSharedRootDir());
 421
 422     WrtUtilMakeDir(sharedPath);
 423
 424     if (m_context.isUpdateMode) { //update
 425         std::string backData = m_context.locations->getBackupSharedDir();
 426         LogDebug("copy shared storage " << backData << " to " << sharedPath);
 427         if (!DirectoryApi::DirectoryCopy(backData, sharedPath)) {
 428             LogError("Failed to rename " << backData << " to " << sharedPath);
 429             ThrowMsg(Exceptions::BackupFailed,
 430                     "Error occurs copy shared strage files");
 431         }
 432     } else {
 433         WrtUtilMakeDir(m_context.locations->getSharedResourceDir());
 434         changeOwnerForDirectory(m_context.locations->getSharedDataDir(),
 435                 SHARED_STORAGE_MODE);
 436         changeOwnerForDirectory(m_context.locations->getSharedTrustedDir(),
 437                 SHARED_STORAGE_MODE);
 438     }
 439 }
 440
 441 void TaskFileManipulation::StartStep()
 442 {
 443     LogDebug("--------- <TaskFileManipulation> : START ----------");
 444 }
 445
 446 void TaskFileManipulation::EndStep()
 447 {
 448     LogDebug("--------- <TaskFileManipulation> : END ----------");
 449 }
 450 } //namespace WidgetInstall
 451 } //namespace Jobs