blob: 82a4c1b08e262d221f1beba1bfc8aff4f03c0c54 [file] [log] [blame]
Dees Troy3be70a82013-10-22 14:25:12 +00001/*
2 Copyright 2012 bigbiff/Dees_Troy TeamWin
3 This file is part of TWRP/TeamWin Recovery Project.
5 TWRP is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation, either version 3 of the License, or
8 (at your option) any later version.
10 TWRP is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with TWRP. If not, see <>.
Dees_Troy6ef66352013-02-21 08:26:57 -060019#ifndef _TWRPFUNCTIONS_HPP
22#include <string>
Dees_Troy2673cec2013-04-02 20:22:16 +000023#include <vector>
Dees_Troy6ef66352013-02-21 08:26:57 -060024
25using namespace std;
27typedef enum
Vojtech Bocekfafb0c52013-07-25 22:53:02 +020029 rb_current = 0,
30 rb_system,
31 rb_recovery,
32 rb_poweroff,
33 rb_bootloader, // May also be fastboot
34 rb_download,
Dees_Troy6ef66352013-02-21 08:26:57 -060035} RebootCommand;
bigbiffce8f83c2015-12-12 18:30:21 -050037enum Archive_Type {
Dees_Troy6ef66352013-02-21 08:26:57 -060044// Partition class
45class TWFunc
Dees_Troy6ef66352013-02-21 08:26:57 -060048 static string Get_Root_Path(string Path); // Trims any trailing folders or filenames from the path, also adds a leading / if not present
49 static string Get_Path(string Path); // Trims everything after the last / in the string
50 static string Get_Filename(string Path); // Trims the path off of a filename
Ethan Yonkeraf2897c2014-02-10 13:07:14 -060052 static int Exec_Cmd(const string& cmd, string &result); //execute a command and return the result as a string by reference
53 static int Exec_Cmd(const string& cmd); //execute a command
54 static int Wait_For_Child(pid_t pid, int *status, string Child_Name); // Waits for pid to exit and checks exit status
Ethan Yonkerddb63e22017-01-19 14:01:57 -060055 static int Wait_For_Child_Timeout(pid_t pid, int *status, const string& Child_Name, int timeout); // Waits for a pid to exit until the timeout is hit. If timeout is hit, kill the chilld.
Ethan Yonkeraf2897c2014-02-10 13:07:14 -060056 static bool Path_Exists(string Path); // Returns true if the path exists
bigbiffce8f83c2015-12-12 18:30:21 -050057 static Archive_Type Get_File_Type(string fn); // Determines file type, 0 for unknown, 1 for gzip, 2 for OAES encrypted
Ethan Yonkeraf2897c2014-02-10 13:07:14 -060058 static int Try_Decrypting_File(string fn, string password); // -1 for some error, 0 for failed to decrypt, 1 for decrypted, 3 for decrypted and found gzip format
Ethan Yonker472f5062016-02-25 13:47:30 -060059 static unsigned long Get_File_Size(const string& Path); // Returns the size of a file
Vojtech Bocek05f87d62014-03-11 22:08:23 +010060 static std::string Remove_Trailing_Slashes(const std::string& path, bool leaveLast = false); // Normalizes the path, e.g /data//media/ -> /data/media
Matt Mower2416a502016-04-12 19:54:46 -050061 static void Strip_Quotes(char* &str); // Remove leading & trailing double-quotes from a string
Ethan Yonker1b7a31b2014-07-03 15:09:22 -050062 static vector<string> split_string(const string &in, char del, bool skip_empty);
Ethan Yonker472f5062016-02-25 13:47:30 -060063 static timespec timespec_diff(timespec& start, timespec& end); // Return a diff for 2 times
64 static int32_t timespec_diff_ms(timespec& start, timespec& end); // Returns diff in ms
Ethan Yonkeraf2897c2014-02-10 13:07:14 -060065
Dees_Troy6ef66352013-02-21 08:26:57 -060067 static void install_htc_dumlock(void); // Installs HTC Dumlock
68 static void htc_dumlock_restore_original_boot(void); // Restores the backup of boot from HTC Dumlock
69 static void htc_dumlock_reflash_recovery_to_boot(void); // Reflashes the current recovery to boot
70 static int Recursive_Mkdir(string Path); // Recursively makes the entire path
Dees_Troy6ef66352013-02-21 08:26:57 -060071 static void GUI_Operation_Text(string Read_Value, string Default_Text); // Updates text for display in the GUI, e.g. Backing up %partition name%
72 static void GUI_Operation_Text(string Read_Value, string Partition_Name, string Default_Text); // Same as above but includes partition name
Dees_Troy2673cec2013-04-02 20:22:16 +000073 static void Update_Log_File(void); // Writes the log to last_log
74 static void Update_Intent_File(string Intent); // Updates intent file
Dees_Troy6ef66352013-02-21 08:26:57 -060075 static int tw_reboot(RebootCommand command); // Prepares the device for rebooting
76 static void check_and_run_script(const char* script_file, const char* display_name); // checks for the existence of a script, chmods it to 755, then runs it
Dees_Troy6ef66352013-02-21 08:26:57 -060077 static int removeDir(const string path, bool removeParent); //recursively remove a directory
78 static int copy_file(string src, string dst, int mode); //copy file from src to dst with mode permissions
79 static unsigned int Get_D_Type_From_Stat(string Path); // Returns a dirent dt_type value using stat instead of dirent
bigbiff bigbiffcdcfee42013-02-27 21:11:26 -050080 static int read_file(string fn, vector<string>& results); //read from file
Dees_Troy6ef66352013-02-21 08:26:57 -060081 static int read_file(string fn, string& results); //read from file
xNUTxe85f02d2014-07-18 01:30:58 +020082 static int read_file(string fn, uint64_t& results); //read from file
Dees_Troy6ef66352013-02-21 08:26:57 -060083 static int write_file(string fn, string& line); //write from file
Dees_Troy6ef66352013-02-21 08:26:57 -060084 static bool Install_SuperSU(void); // Installs su binary and apk and sets proper permissions
Dees_Troy83bd4832013-05-04 12:39:56 +000085 static bool Try_Decrypting_Backup(string Restore_Path, string Password); // true for success, false for failed to decrypt
Ethan Yonkerb5557892014-02-07 21:43:20 -060086 static string System_Property_Get(string Prop_Name); // Returns value of Prop_Name from reading /system/build.prop
Dees Troyb21cc642013-09-10 17:36:41 +000087 static string Get_Current_Date(void); // Returns the current date in ccyy-m-dd--hh-nn-ss format
88 static void Auto_Generate_Backup_Name(); // Populates TW_BACKUP_NAME with a backup name based on current date and from /system/build.prop
Vojtech Bocekd0e38bc2014-02-03 23:36:57 +010089 static void Fixup_Time_On_Boot(); // Fixes time on devices which need it
Vojtech Bocek0b7fe502014-03-13 17:36:52 +010090 static std::vector<std::string> Split_String(const std::string& str, const std::string& delimiter, bool removeEmpty = true); // Splits string by delimiter
Vojtech Bocek03fd6c52014-03-13 18:46:34 +010091 static bool Create_Dir_Recursive(const std::string& path, mode_t mode = 0755, uid_t uid = -1, gid_t gid = -1); // Create directory and it's parents, if they don't exist. mode, uid and gid are set to all _newly_ created folders. If whole path exists, do nothing.
xNUTxe85f02d2014-07-18 01:30:58 +020092 static int Set_Brightness(std::string brightness_value); // Well, you can read, it does what it says, passing return int from TWFunc::Write_File ;)
bigbiff bigbiffc7eee6f2014-09-02 18:59:01 -040093 static bool Toggle_MTP(bool enable); // Disables MTP if enable is false and re-enables MTP if enable is true and it was enabled the last time it was toggled off
Jenkins1710bf22014-10-02 20:22:21 -040094 static std::string to_string(unsigned long value); //convert ul to string
Tom Hite5a926722014-09-15 01:31:03 +000095 static void SetPerformanceMode(bool mode); // support recovery.perf.mode
Ethan Yonker9132d912015-02-02 10:32:49 -060096 static void Disable_Stock_Recovery_Replace(); // Disable stock ROMs from replacing TWRP with stock recovery
Ethan Yonker483e9f42016-01-11 22:21:18 -060097 static unsigned long long IOCTL_Get_Block_Size(const char* block_device);
bigbiff bigbiffbad332a2016-07-29 21:18:13 -040098 static void copy_kernel_log(string curr_storage); // Copy Kernel Log to Current Storage (PSTORE/KMSG)
Tom Hite5a926722014-09-15 01:31:03 +000099
Dees_Troy6ef66352013-02-21 08:26:57 -0600100private:
Dees_Troy2673cec2013-04-02 20:22:16 +0000101 static void Copy_Log(string Source, string Destination);
Dees_Troy6ef66352013-02-21 08:26:57 -0600102
Dees_Troy2673cec2013-04-02 20:22:16 +0000105extern int Log_Offset;
Ethan Yonkeraf2897c2014-02-10 13:07:14 -0600106#else
108#endif // ndef BUILD_TWRPTAR_MAIN
Dees_Troy2673cec2013-04-02 20:22:16 +0000109
Dees_Troy6ef66352013-02-21 08:26:57 -0600110#endif // _TWRPFUNCTIONS_HPP