src/modules/tizen/Filesystem/Command.h

   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  * @author          Zbigniew Kostrzewa (z.kostrzewa@samsung.com)
  18  */
  19
  20 #ifndef WRTDEVICEAPIS_FILESYSTEM_COMMAND_H_
  21 #define WRTDEVICEAPIS_FILESYSTEM_COMMAND_H_
  22
  23 #include <string>
  24
  25 namespace WrtDeviceApis {
  26 namespace Filesystem {
  27
  28 class Command
  29 {
  30   public:
  31     virtual ~Command()
  32     {
  33     }
  34     void execute();
  35
  36   protected:
  37     /**
  38      * Returns command converted into string that has to be safe to be executed
  39      * using system() function (@see man 3p system).
  40      * @attention Underlying command has to be passed by absolute path.
  41      *            E.g. use '/bin/cp' instead of just 'cp'.
  42      * @attention Do not chain a few commands as one.
  43      *            This is wrong: 'cmd1 && cmd2; cmd3'.
  44      * @return Command string - please ensure that the command is safe to run.
  45      */
  46     virtual std::string prepare() = 0;
  47 };
  48
  49 }
  50 }
  51
  52 #endif // WRTDEVICEAPIS_FILESYSTEM_COMMAND_H_