blob: e91f7dd11f728bee003d7ad007b879b43d8ec283 [file] [log] [blame]
Dees_Troy240e4a72012-09-04 09:22:39 -04001/* Partition Management classes for TWRP
2 *
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License version 2 and
5 * only version 2 as published by the Free Software Foundation.
6 *
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * GNU General Public License for more details.
11 *
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
15 * 02110-1301, USA.
16 *
17 * The code was written from scratch by Dees_Troy dees_troy at
18 * yahoo
19 *
20 * Copyright (c) 2012
21 */
23#ifndef __TWRP_Partition_Manager
24#define __TWRP_Partition_Manager
26#include "data.hpp"
27#include <vector>
28#include <string>
29#include <map>
31// Partition class
32class TWPartition
35 enum Backup_Method_enum {
36 NONE = 0,
37 FILES = 1,
38 DD = 2,
40 };
43 TWPartition();
44 virtual ~TWPartition();
47 virtual bool Is_Mounted(); // Checks mount to see if the partition is currently mounted
48 virtual bool Mount(bool Display_Error); // Mounts the partition if it is not mounted
49 virtual bool UnMount(bool Display_Error); // Unmounts the partition if it is mounted
50 virtual bool Wipe(); // Wipes the partition
51 virtual bool Backup(string backup_folder); // Backs up the partition to the folder specified
52 virtual bool Restore(string restore_folder); // Restores the partition using the backup folder provided
53 static string Backup_Method_By_Name(); // Returns a string of the backup method for human readable output
54 virtual bool Decrypt(string Password); // Decrypts the partition, return 0 for failure and -1 for success
55 virtual bool Wipe_Encryption(); // Ignores wipe commands for /data/media devices and formats the original block device
56 void Check_FS_Type(); // Checks the fs type using blkid, does not do anything on MTD / yaffs2 because this crashes on some devices
59 bool Process_Fstab_Line(string Line); // Processes a fstab line
62 bool Can_Be_Mounted; // Indicates that the partition can be mounted
63 bool Can_Be_Wiped; // Indicates that the partition can be wiped
64 bool Wipe_Available_in_GUI; // Inidcates that the wipe can be user initiated in the GUI system
65 bool Is_SubPartition; // Indicates that this partition is a sub-partition of another partition (e.g. datadata is a sub-partition of data)
66 string SubPartition_Of; // Indicates which partition is the parent partition of this partition (e.g. data is the parent partition of datadata)
67 string Symlink_Path; // Symlink path (e.g. /data/media)
68 string Symlink_Mount_Point; // /sdcard could be the symlink mount point for /data/media
69 string Mount_Point; // Mount point for this partition (e.g. /system or /data)
70 string Block_Device; // Block device (e.g. /dev/block/mmcblk1p1)
71 string Alternate_Block_Device; // Alternate block device (e.g. /dev/block/mmcblk1)
72 bool Removable; // Indicates if this partition is removable -- affects how often we check overall size, if present, etc.
73 bool Is_Present; // Indicates if the partition is currently present as a block device
74 int Length; // Used by make_ext4fs to leave free space at the end of the partition block for things like a crypto footer
75 unsigned long long Size; // Overall size of the partition
76 unsigned long long Used; // Overall used space
77 unsigned long long Free; // Overall free space
78 unsigned long long Backup_Size; // Backup size -- may be different than used space especially when /data/media is present
79 bool Can_Be_Encrypted; // This partition might be encrypted, affects error handling, can only be true if crypto support is compiled in
80 bool Is_Encrypted; // This partition is thought to be encrypted -- it wouldn't mount for some reason, only avialble with crypto support
81 bool Is_Decrypted; // This partition has successfully been decrypted
82 string Decrypted_Block_Device; // Decrypted block device available after decryption
83 string Display_Name; // Display name for the GUI
84 string Backup_Name; // Backup name -- used for backup filenames
85 Backup_Method_enum Backup_Method; // Method used for backup
86 bool Has_Data_Media // Indicates presence of /data/media, may affect wiping and backup methods
87 bool Is_Storage // Indicates if this partition is used for storage for backup, restore, and installing zips
88 string Storage_Path // Indicates the path to the storage -- root indicates mount point, media/ indicates e.g. /data/media
89 string Current_File_System // Current file system
90 string Fstab_File_System // File system from the recovery.fstab
91 int Format_Block_Size // Block size for formatting
94 bool Wipe_EXT23(); // Formats as ext3 or ext2
95 bool Wipe_EXT4(); // Formats using ext4, uses make_ext4fs when present
96 bool Wipe_FAT(); // Formats as FAT except that mkdosfs from busybox usually fails so oftentimes this is actually a rm -rf wipe
97 bool Wipe_YAFFS2(); // Formats as yaffs2 for MTD memory types
98 bool Wipe_RMRF(); // Uses rm -rf to wipe
99 bool Wipe_Data_Without_Wiping_Media(); // Uses rm -rf to wipe but does not wipe /data/media
100 bool Backup_Tar(string backup_folder); // Backs up using tar for file systems
101 bool Backup_DD(string backup_folder); // Backs up using dd for emmc memory types
102 bool Backup_Dump_Image(string backup_folder); // Backs up using dump_image for MTD memory types
103 bool Restore_Tar(string restore_folder); // Restore using tar for file systems
104 bool Restore_DD(string restore_folder); // Restore using dd for emmc memory types
105 bool Restore_Flash_Image(string restore_folder); // Restore using flash_image for MTD memory types
107friend class TWPartitionManager;
110class TWPartitionManager
113 TWPartitionManager();
114 virtual ~TWPartitionManager();
117 virtual int Process_Fstab(string Fstab_Filename, bool Display_Error); // Parses the fstab and populates the partitions
118 virtual int Mount_By_Path(string Path, bool Display_Error); // Mounts partition based on path (e.g. /system)
119 virtual int Mount_By_Block(string Block, bool Display_Error); // Mounts partition based on block device (e.g. /dev/block/mmcblk1p1)
120 virtual int Mount_By_Name(string Name, bool Display_Error); // Mounts partition based on display name (e.g. System)
121 virtual int UnMount_By_Path(string Path, bool Display_Error); // Unmounts partition based on path
122 virtual int UnMount_By_Block(string Block, bool Display_Error); // Unmounts partition based on block device
123 virtual int UnMount_By_Name(string Name, bool Display_Error); // Unmounts partition based on display name
124 virtual int Is_Mounted_By_Path(string Path); // Checks if partition is mounted based on path
125 virtual int Is_Mounted_By_Block(string Block); // Checks if partition is mounted based on block device
126 virtual int Is_Mounted_By_Name(string Name); // Checks if partition is mounted based on display name
127 static *Partition Find_Partition_By_Path(string Path); // Returns a pointer to a partition based on path
128 static *Partition Find_Partition_By_Block(string Block); // Returns a pointer to a partition based on block device
129 virtual int Run_Backup(string Backup_Name); // Initiates a backup in the current storage
130 virtual int Run_Restore(string Restore_Name); // Restores a backup
131 void Set_Restore_Files(string Restore_Name); // Used to gather a list of available backup partitions for the user to select for a restore
132 virtual int Wipe_By_Path(string Path); // Wipes a partition based on path
133 virtual int Wipe_By_Block(string Block); // Wipes a partition based on block device
134 virtual int Wipe_By_Name(string Name); // Wipes a partition based on display name
135 void Refresh_Sizes(); // Refreshes size data of partitions
138 std::vector<TWPartition*> Partitions;
141#endif // __TWRP_Partition_Manager