Hi friends of XDA,
I created this tutorial especially for noobs who would like to know how the clockworkmod uses the .zip
file and what and all goes into the process of flashing a .zip file and mainly about the format and syntax used in updater-script.
first is first!
#include
/*
* I am not responsible for bricked devices, dead SD cards or
* thermonuclear war.
* do some research if you have any concerns.
* YOU are choosing to make these modifications.
* yes, i copied this disclaimer from FXP because it is cool and i am lazy!
*/
now what is the updater-script and update-binary present in the META-INF>com>google>android in any flashable zip package?
1. updater-script - it is just a text file which contains all the commands which tells the clockworkmod what to do with the given
zip file. the updater-script is written in the edify scripting language.
2. update-binary - it is a binary which is requiered by the clockworkmod to translate the human readable format of the updater-
script to machine readable format for execution of the updater-script in our device.
exploring the updater-script:
now let's start exploring the updater-script !
1. open the updater script with notepad++ (strongly recommended)
2. now i will try and explain commands generally used in the updater-script,
assert(getprop("ro.product.device") == "ST15i" || getprop("ro.build.product") == "ST15i" ||
getprop("ro.product.device") == "ST15a" || getprop("ro.build.product") == "ST15a" ||
getprop("ro.product.device") == "smultron" || getprop("ro.build.product") == "smultron");
the above bunch of lines checks the device model to confirm that the zip file is flashed on the device
for which it is specifically created for. These bunch of lines are very important because it prevents
flashing of zip file which is not intended for the device hence avoiding any problems due to flashing
the wrong zip. for example the above lines checks for the value of "ro.product.device" and
"ro.build.product"in the build.prop file of the already existing rom in the device, if any of the three
defined values ST15i, ST15a, smultron are found it will continue with the next line of updater-script
otherwise flashing gets aborted with error in getprop.
format("yaffs2", "MTD", "system", "/system");
the above command explains itself, it is used to format the specified partition
syntax explanation:
format - the main command to direct the cwm to format using the following parameters
"yaffs2" - filesystem type used in the device
"MTD" - type of the partition used in the file system
"system" - name of the partition to be formatted
"/system" - location of the partition to be formatted
ui_print("Format Completed");
the above command is also self explanatory, it directs the cwm to display the following text
enclosed in double quotes in the user interface (display).
after succesful formatting it displays "Format Completed" in the device screen.
mount("yaffs2", "MTD", "system", "/system");
the mount command directs the cwm to mount the following file system and the following partition
the syntax is just as explained in the format command except that this command mounts the
defined partition whereas the format command formats the defined partition.
let's review what we have done till now,
1. we have checked the device to confirm that this is the device for which we created the zip.
2. we have formatted the system partition of the device.(this is only done when a new complete rom is being flashed, for flashing mods you
should never format the system partition!)
3. we have mounted the system partition of the device.
now let's continue,
package_extract_dir("system", "/system");
this command searches for the directory (folder) named "system" in the root of the zip file and
copies all the content of the "system" folder from the zip file into the "/system" partition
which is already mounted by the previous mount command.
remember the structure of the file system in the zip file and the "/system" partition of the device must be always identical.
for eg., you have created a mod by editing the systemUI.apk and you want to flash it, the system UI.apk resides in "/system/app"
so the structure of the file system in the update zip should be "/system/app/systemUI.apk"
ie., the update zip should contain folder named "system" at the root of it and folder named "app" inside the "system" folder and the
modded "systemUI.apk" must be placed inside the "app" folder.
package_extract_file("autoroot.sh", "/tmp/autoroot.sh");
this command searches for the file named "autoroot.sh" in the root of the zip file and
copies the file to "/tmp" folder and names it as "autoroot.sh" (here it does not change the name)
symlink("mksh", "/system/bin/sh");
the above command creates a symlink.
okay, now let's see about symlinks,
symlink is nothing but shortcuts, for example if a file is requiered in two different places instead of copy pasting the file
in two different locations, the file is copied to one of the two locations and in the other location a shortcut to the file(symlink)
is created. the source and the symlink can have different names (actually this is the prime use of symlinks).
to explain in a noob friendly manner,
take the above symlink, it creates a shortcut(symlink) for the command "mksh" and places it in the path of the operating system.
the shortcut(symlink) directs to the file "/system/bin/sh" , so whenever the os gets a request to execute the "mksh" command, the actual
binary that gets excuted will be "/system/bin/sh" .
creating symlinks saves a lot of space because instead of copying the whole file and placing it in requiered places we are just
creating shortcuts which directs to the source file which can be placed anywhere in the file system (generally placed in the path of the os).
set_perm_recursive(0, 0, 0755, 0644, "/system");
the above command is used to set permission recursively for the files and folders present inside a folder (in this case for "/system" folder).
syntax explanation:
0 - uid - it defines that the following permission is set for the user id 0 .
0 - gid - it defines that the following permission is set for the group id 0 .
0775 - dirmode - it defines that 0775 permission to set to directories contained within the specified directory.
0644 - filemode - it defines that 0644 permission to set to files contained within the specified directory.
"/system" - target directory to set the above mentioned permissions.
set_perm(0, 3003, 06755, "/system/bin/ip");
the above command is used to set permission for a individual file (in this case for "/system/bin/ip" file).
syntax explanation:
0 - uid - it defines that the following permission is set for the user id 0 .
3003 - gid - it defines that the following permission is set for the group id 3003 .
06775 - it defines that 06775 permission to set to the specific file.
"/system/bin/ip" - target file to set the above mentioned permissions.
run_program("/tmp/autoroot.sh");
remember the file autoroot.sh from package_extract_file command?
that file is supposed to be a shell script, the above command directs cwm to execute the "autoroot.sh" shell script present in "/tmp" folder.
unmount("/system");
the unmount command directs the cwm to unmount the following partition
the syntax is just as explained in the mount command except that this command unmounts the
defined partition whereas the mount command mounts the defined partition.
Okay now going into slightly complex and/or not widely used updater-script commands,
Ifelse
Syntax:
Ifelse(condition),(do_this),(else_do_this);
Example:
ifelse mount("yaffs2", "MTD", "system", "/system") == "system", ui_print("Mounted!"), ui_print("Mount Failed!");
Ifelse command can be explained simply as asking the system to do something based on the result of a condition.
From the example:
The ifelse command would attempt to mount the MTD partition named "system" to "/system".
If the mounting process succeeds (the condition), the script will display "Mounted!", else it will display "Mount Failed!"
abort()
It just abort's the script execution
Note: it is usually paired with some other command for example the getprop command or with ifelse.
Independently specifying abort() in the updater-script will kill the script abruptly right there so use this command carefully.
ALWAYS LEAVE A BLANK LINE AT THE END OF THE update-script (if the code contains 50 lines then 51 lines should be visible
in the notepad++ including a blank line after the end of the script)
ALWAYS REMEMBER TO SET THE EOL (end of line) CONVERSION OF updater-script
IN UNIX FORMAT BEFORE SAVING (notepad++ > edit > EOL conversion > UNIX format)
the above mentioned commands are just basic edify scripting commands which are generally used in updater-script.
for detailed scripting and coding in edify scripting language check out the following sources:
source of update-binary
introdution to edify
http://forum.xda-developers.com/wiki/Edify_script_language
scratchpad-documenting-edify-commands-for-android-updater-scritps
http://forum.xda-developers.com/showthread.php?t=1290062
HIT THANKS IF I HAVE HELPED YOU!
Nice tut bro
bandarigoda123 said:
Nice tut bro
Click to expand...
Click to collapse
thanks friend
Great piece of work buddy.... :good:
This is good for me:beer:
Sent from my HTC EVO 3D X515m using xda app-developers app
What l must to change here? I got error 7
Sent from my HTC EVO 3D X515m using xda app-developers app
analoncarkg said:
What l must to change here? I got error 7
Sent from my HTC EVO 3D X515m using xda app-developers app
Click to expand...
Click to collapse
Have you set the eol conversion to Unix format as described?
Have you left a blank line as described?
Make sure that Cyanogenmod Rom is for your device. Then try flashing again.
If the above mentioned steps fails and you still get a status 7 error or assert failed error then make SURE that the Rom is really specific for your device and remove the first three lines from the script
Remove lines starting From "assert" to "smultron");
Make sure that after removing the above specified three lines there is no blank line at the start of the script And flash again
Usually status 7 errors are due to bad formatting of the updater-script or in rare cases it is due to corrupted or incomplete download of the Rom.
hit thanks if I've helped!
sent from my smultron
here are some more commands if you like:
sleep();
show_progress(1.0, "1000"); more on this here: http://forum.xda-developers.com/showthread.php?t=1290062
if/ then/ endif; syntax
iONEx said:
here are some more commands if you like:
sleep();
show_progress(1.0, "1000"); more on this here: http://forum.xda-developers.com/showthread.php?t=1290062
if/ then/ endif; syntax
Click to expand...
Click to collapse
Thanks iONEX I knew them before but didn't add sleep and show_progress because they are just mere cosmetic changes and don't serve any serious purpose anyways I'll add them after understanding and testing
And about if/then/endif/ifelse , generally they are used rarely in updater-script but I'll add them anyways after understanding testing!
Thanks!
hit thanks if I've helped!
sent from my smultron
If anyone is interested in the source of the update-binary, I've added the link to it in the first post
hit thanks if I've helped!
sent from my smultron
Hello! How exactly should I write in the updater-script if I need to make the system folder rewriteable and then delete the existing framework-res.apk from system/framework and then copy a new framework-res.apk from the .zip file, then change the permissions of it and finally make the system folder write-only again?
My "idea" is something like this:
1. Content of the updater-script:
ui_print("Please wait...");
mount("MTD", "system", "/system");
delete("/system/framework/framework-res.apk");
package_extract_dir("system", "/system");
set_perm(0, 0, 04755, "/system/framework/framework-res.apk");
ui_print("Done");
unmount("/system");
2. Make a signed .zip file that would contain:
- system\framework\framework-res.apk
- META-INF\com\google\android\updater-script
3. Run the .zip from memory card via recovery
Would it work like this?
Note: My phone is bricked because of framework-res.apk and USB debugging is off, so this is the only way I could unbrick it.
You must have a unmodified updater-script in your meta-inf folder right?? Paste the "mount" command syntax here. It must be in the first few lines.
#pitchblack5691#
Actually I don't. I have to create it from scratch.
No. . . You need a meta-inf folder to work with which contains the signature files and a update-binary to create a flashable zip.
#pitchblack5691#
I only created those folders and an updater-script file and then I packed it & signed it using Update Zip Packager 3.0. The only update-binary file that I have is the one that's included with Update Zip Packager.
Code:
mount("MTD", "system", "/system");
ui_print("started. . . .");
delete("/system/framework/framework-res.apk");
package_extract_dir("system", "/system");
set_perm(0, 0, 0644, "/system/framework/framework-res.apk");
unmount("/system");
ui_print("finished");
This should work and you need a meta-inf folder extracted from some flashable zip. You can't create a meta-inf folder from scratch without using signature files and update-binary.
EDIT: what you said above will work. You either should have a meta-inf folder with signature files or a signing software.
And you don't have to give 755 permissions to an app because even though they are apps, technically they are not executed and only read from so no need for 755 permission. 644 permission should suffice and it's the default permission for a system app. . . 755 permissions is only useful for executable binaries and scripts.
#pitchblack5691#
I've just tried it. It returns this error:
...
Installing update...
E:Error in /tmp/sideload/package.zip
(Status 2)
Installation aborted.
E:Can't find misc
What does it mean please?
What code exactly you are using in the updater-script?? Paste the full code and paste the name of files present in the zip file in a hierarchical order.
#pitchblack5691#
The .zip contains these files:
Code:
META-INF\CERT.RSA
META-INF\CERT.SF
META-INF\MANIFEST.MF
META-INF\com\google\android\update-binary
META-INF\com\google\android\updater-script
system\framework\framework-res.apk
The code of updater-script:
Code:
mount("MTD", "system", "/system");
ui_print("started. . . .");
delete("/system/framework/framework-res.apk");
package_extract_dir("system", "/system");
set_perm(0, 0, 0644, "/system/framework/framework-res.apk");
unmount("/system");
ui_print("finished");
Bootloader unlocked?? Custom kernel?? Or installed cwm in a bootloader locked phone??? Looks like your cwm is not working properly. . .
#pitchblack5691#
Hi, I am doing na updater-script for flashable zip package, but I am stuck on certain point:
I would like to make changes in following location:
Code:
/res/customconfig/
so I need to execute (in my script)
Code:
run_program ("/sbin/busybox", "mount", "/?????");
what I need to know how can I determine what to mount to get access to the /res/customconfig/, e.g. if there is a command I can use to determine using terminal etc ...
Thanks for answer
Hi, i have base rom (aosp android 6.0.1) and i want add some app to my rom. For this i extract cm13 rom.zip with winrar and unpack system.new.dat with SYSTEM EXTRACTOR v3 and add my apps and repack it and after create a zip file name " update.zip" and sign it [adapted xda University guide ]. Now i want flash that with twrp 3 and show this
Installing zip file '/external_sd/AOSP-RRO-6.0.1-20160417-huashan-adriandc.zip' Checking for MD5 file... Skipping MD5 check: no MD5 file found I:Zip contains SELinux file_contexts file in its root. Extracting to /file_contexts I:Legacy property environment initialized. Target: Sony/C5303/C5303:4.3/12.1.A.1.207/Nvt_nw:user/release-keys minzip: Extracted 0 file(s) about to run program [/tmp/install/bin/otasigcheck.sh] with 1 args run_program: execv failed: No such file or directory run_program: child exited with status 1 performing update blockimg version is 1 erasing 524288 blocks BLKDISCARD ioctl failed: Invalid argument Patching system image unconditionally... failed to execute command [erase 2,0,524288 ] Verifying the updated system image... script aborted: system partition has unexpected contents after OTA update system partition has unexpected contents after OTA update Updater process ended with ERROR: 7 I:Legacy property environment disabled. Error installing zip file '/external_sd/AOSP-RRO-6.0.1-20160417-huashan-adriandc.zip'
I dont know whats Problem . Please help me
sent from Xperia™ SP | Android 6.0.1
hamed24 said:
Hi, i have base rom (aosp android 6.0.1) and i want add some app to my rom. For this i extract cm13 rom.zip with winrar and unpack system.new.dat with SYSTEM EXTRACTOR v3 and add my apps and repack it and after create a zip file name " update.zip" and sign it [adapted xda University guide ]. Now i want flash that with twrp 3 and show this
Installing zip file '/external_sd/AOSP-RRO-6.0.1-20160417-huashan-adriandc.zip' Checking for MD5 file... Skipping MD5 check: no MD5 file found I:Zip contains SELinux file_contexts file in its root. Extracting to /file_contexts I:Legacy property environment initialized. Target: Sony/C5303/C5303:4.3/12.1.A.1.207/Nvt_nw:user/release-keys minzip: Extracted 0 file(s) about to run program [/tmp/install/bin/otasigcheck.sh] with 1 args run_program: execv failed: No such file or directory run_program: child exited with status 1 performing update blockimg version is 1 erasing 524288 blocks BLKDISCARD ioctl failed: Invalid argument Patching system image unconditionally... failed to execute command [erase 2,0,524288 ] Verifying the updated system image... script aborted: system partition has unexpected contents after OTA update system partition has unexpected contents after OTA update Updater process ended with ERROR: 7 I:Legacy property environment disabled. Error installing zip file '/external_sd/AOSP-RRO-6.0.1-20160417-huashan-adriandc.zip'
I dont know whats Problem . Please help me
sent from Xperia™ SP | Android 6.0.1
Click to expand...
Click to collapse
Any body can't help me !!
sent from Xperia™ SP | Android 6.0.1
Hello Everyone
I created a small flashable zip in order to remove the apps I don't want COMPLETELY from /system/app but for no apparent reason it doesn't remove anything.
Here's what I have wrote inside the updater-script file :
Code:
unmount("/system");
unmount("/data");
unmount("/preload");
ui_print(" ");
ui_print("Mounting partitions..");
run_program("/sbin/mount", "-t", "auto", "/system");
run_program("/sbin/mount", "-t", "auto", "/data");
run_program("/sbin/mount", "-t", "auto", "/cache");
ui_print("Partitions mounted.");
ui_print("Starting debloat process..");
ui_print("Removing apps from /system/app");
delete_recursive("/system/app/BookmarkProvider");
run_program("/sbin/rm", "-rf", "system/app/Browser");
run_program("/sbin/rm", "-rf", "system/app/FaceUnlockService-res");
run_program("/sbin/rm", "-rf", "system/app/NfcNci");
ui_print(" ");
ui_print("Removal Process Finished.");
ui_print(" ");
ui_print("Cleaning Cache");
run_program("/sbin/rm", "-rf", "/cache");
ui_print(" ");
ui_print("Unmounting partitions: /system /data /cache");
unmount("/data");
unmount("/cache");
unmount("/system");
ui_print(" ");
It's mind boggling because the script runs flawlessly when I flash it through Recovery except it doesn't remove ANYTHING!
Some one please tell me what am I doing wrong here?
I've also attached the flashable zip file.
Device : Samsung Galaxy Note 3
Rom : LineageOS (Rooted with Magisk)
Recovery : TWRP 3.4.0-1 (Latest)
Busybox : Installed through Magisk.
Thanks.
Excerpt of known commands in OTA updater-script
unmount
Syntax
unmount <mount_point>
Description
Unmounts the filesystem mounted at mount_point.
run_program
Syntax
run_program <program-file> [<args> ...]
Description
Run an external program included in the update package.
delete_recursive
Syntax
delete_recursive <file-or-dir1> [... <file-or-dirN>]
Description
Delete a file or directory with all of it's contents recursively.
mount
Syntax
mount <fs_type, partition_type, name, mount_point>
Description
Mounts a filesystem of fs_type at mount_point. partition_type must be one of these: system , userdata, etc.pp.
This in mind the main failure in your script is misuse of run_program, IMHO
Spoiler
Mount.
You could test those using terminal first...
But why not just use TWRP's file manager?
jwoegerbauer said:
Excerpt of known commands in OTA updater-script
unmount
Syntax
unmount <mount_point>
Description
Unmounts the filesystem mounted at mount_point.
run_program
Syntax
run_program <program-file> [<args> ...]
Description
Run an external program included in the update package.
delete_recursive
Syntax
delete_recursive <file-or-dir1> [... <file-or-dirN>]
Description
Delete a file or directory with all of it's contents recursively.
mount
Syntax
mount <fs_type, partition_type, name, mount_point>
Description
Mounts a filesystem of fs_type at mount_point. partition_type must be one of these: system , userdata, etc.pp.
This in mind the main failure in your script is misuse of run_program, IMHO
Click to expand...
Click to collapse
Can you please point out to where the problem comes from precisly and what's wrong with the run_program command I wrote? Sorry I'm total noob
CXZa said:
Spoiler
Mount.
You could test those using terminal first...
But why not just use TWRP's file manager?
Click to expand...
Click to collapse
I appreciate your help but I still cannot figure it out. This is just a snip from a big list of apps that I try to debloat so that's why I created this flashable zip.
Marvino. said:
I appreciate your help but I still cannot figure it out. This is just a snip from a big list of apps that I try to debloat so that's why I created this flashable zip.
Click to expand...
Click to collapse
Deleting those with file manager is much faster than typing that script...
How about mounting them first in TWRP and then running the script? Of course edit it 1st so it skips the mounting part...
BTW, yours looks like very much like this one.
Easy debloat script for Oreo Stock ROMs
I haven't seen anyone post any easy debloat script, so here is my personal one for N8. This is made for OREO - but it will work for Nougat-based ROMs too, as long as the file names haven't been changed. This could also work well for S8, S9 and...
forum.xda-developers.com
Marvino. said:
Can you please point out to where the problem comes from precisly and what's wrong with the run_program command I wrote? Sorry I'm total noob
Click to expand...
Click to collapse
Why not simply carefully read my post? And also why do you ignore that within an updater-script the built-in mount and delete_recursive functions have to be used, instead of run_program - what indeed serves a complete other purpose?
Again:
Mount
This built-in command mounts a partition, so if you want to operate on files within system and/or data partition you have to mount system partition, data for data partition with this built-in function.
To mount system :
mount(“ext4″, “EMMC”, “/dev/block/mmcblk0p5″, “/system”);
Here mmcblk0p5 is the name of system partition for mtk 6589 chipsets (this name varies from device to device)
To mount data:
mount(“ext4″, “EMMC”, “/dev/block/mmcblk0p7″, “/data”); (partition name varies from device to device)
Take the time and look inside here.
CXZa said:
BTW, yours looks like very much like this one.
Easy debloat script for Oreo Stock ROMs
I haven't seen anyone post any easy debloat script, so here is my personal one for N8. This is made for OREO - but it will work for Nougat-based ROMs too, as long as the file names haven't been changed. This could also work well for S8, S9 and...
forum.xda-developers.com
Click to expand...
Click to collapse
Only to have said it: The updater-script, which is offered with the link - what also circulates under different names on the internet - is crap: the author(s) have no idea how to write a updater-script.
@Marvino.
Code:
delete_recursive("/system/app/BookmarkProvider");
delete_recursive("/system/app/Browser");
delete_recursive("/system/app/FaceUnlockService-res");
delete_recursive("/system/app/NfcNci");
jwoegerbauer said:
Only to have said it: The updater-script, which is offered with the link - what also circulates under different names on the internet - is crap: the author(s) have no idea how to write a updater-script.
Click to expand...
Click to collapse
Well, it might have worked in his device okay. Busybox mount use fstab in /etc. Not normally there in TWRP. So one should use device path as well.
The hardiest part I guess is to select what to remove really. What might work for some, might make a nice little sushi tray for another...
Have never understood it why people use true EDIFY conformant synthax when creating an OTA package: An OTA script can get realized as plain shell script - what makes things drastically easier and device independent.
BTW: All EDIFY functions can get replaced by equivalent user-written functions. See also here,