Android updater-scripts(Edify Script)各函数详细说明(转)

简介: 这是Android系统来运行updater-scripts的Edify语言的基本介绍。 大部分的Edify命名都是函数,当调用这些函数结束的时候,会返回数据给脚本。当然,你也可以使用这些函数的返回值来确认成功与否,例如: ifelse(mount("yaffs2", "MTD", "system", "/system") == "system", ui_print("Successfully Mounted!"), ui_print("Mount Failed!"); 这个命令会尝试去挂载命名为“system”的“MTD”分区到“/system”。

这是Android系统来运行updater-scripts的Edify语言的基本介绍。

大部分的Edify命名都是函数,当调用这些函数结束的时候,会返回数据给脚本。当然,你也可以使用这些函数的返回值来确认成功与否,例如:

ifelse(mount("yaffs2", "MTD", "system", "/system") == "system", ui_print("Successfully Mounted!"), ui_print("Mount Failed!");

这个命令会尝试去挂载命名为“system”的“MTD”分区到“/system”。如果挂载成功,脚本会显示“Successfully Mounted!”,否则会显示“Mount Failed!”。

 

现面是用在Edify的Updater-script中的函数例子:

 

函数名称: mount

函数语法: mount(fs_type, partition_type, location, mount_point)

参数详解: fs_type-----------------"yaffs2" "ext4"

partition_type----------"MTD" "EMMC"

location-----------------分区(partition) 驱动器(device)

mount_poin------------挂载文件系统的目标文件夹(target folder to mount FS)

作用解释: 挂载一个文件系统到指定的挂载点

返回值: 挂载成功则返回挂载点,失败返回null

函数示例: mount("MTD", "system", "/system");挂载system分区,设置返回指针"/system”

mount("vfat", "/dev/block/mmcblk1p2", "/system"); 挂载/dev/block/mmcblk1p2,返回指针"/system”

 

函数名称: is_mounted

函数语法: is_mounted(mount_point)

参数详解: mount_point-----------字符串,检查是否已经挂载的挂载点

作用解释: 检查文件系统是否挂载

返回值: 挂载成功则返回挂载点,失败返回null

函数示例:

 

函数名称: unmount

函数语法: unmount(mount_point)

参数详解: mount_point-----------字符串,要解除挂载的挂载点

作用解释: 解除文件系统挂载

返回值: 解除挂载成功则返回挂载点,失败返回null

函数示例: unmount("/system"); 卸载/system分区

 

函数名称: format

函数语法: format(fs_type, partition_type, location)

参数详解: fs_type-----------------字符串,数据为"yaffs2" 或 "ext4"

partition_type----------字符串, "MTD" "EMMC"

location-----------------字符串, 分区(partition) 驱动器(device)

作用解释: 格式化为指定的文件系统

函数示例: format("MTD", "system");格式化system分区

 

函数名称: delete

函数语法: delete(file1, file2, ..., fileN)

参数详解: 字符串,要删除的文件

作用解释: 删除一个文件。最少指定一个文件;多个文件可以做为多个参数指定

函数示例: delete("/data/zipalign.log");删除文件/data/zipalign.log

 

函数名称: delete_recursive

函数语法: delete_recursive(dir1, dir2,...,dirN)

参数详解: 字符串,要递归删除的目录

作用解释: 删除文件夹及其包含的所有内容。最少指定1个目录;多个目录可以做为多个参数指定

函数示例: delete_recursive("/data/dalvik-cache");删除文件夹/data/dalvik-cache

 

函数名称: show_progress

函数语法: show_progress(frac, sec)

参数详解: frac----------------------进度完成数值

Sec----------------------总秒数

作用解释: 显示在Recovery系统中进度

函数示例: show_progress(0.1, 10);show_progress下面的操作可能进行10s,完成后进度条前进0.1(也就是10%)

 

函数名称: set_progress

函数语法: set_prograss(frac)

参数详解: frac---------------------进度数值

函数示例

 

函数名称: package_extract_dir

函数语法: package_extract_dir(package_path, destination_path)

参数详解: package_path----------字符串,升级包内要提取的目录

destination_path--------字符串,提取文件的目标目录

作用解释: 提取升级包内目录中的所有文件到指定的目标目录

函数示例: package_extract_dir("system", "/system");释放ROM包里system文件夹下所有文件和子文件夹至/system

 

函数名称: package_extract_file

函数语法: package_extract_file(package_path) 或 package_extract_file(package_path, destination_path)

参数详解: package_path----------字符串,升级包内要提取的文件

destination_path-------字符串,提取文件的目标目录

作用解释: 提取升级包内的单个文件到指定的目标目录

函数示例: package_extract_file("my.zip", "/system");解压ROM包里的my.zip文件至/system

 

函数名称: file_getprop

函数语法: file_getprop(file, key)

参数详解: file----------------------字符串,要检查的文件名

Key----------------------字符串,返回数据中的文件的键名字

作用解释: 在格式"key"="value"的文件中取得文件属性值

函数示例

 

函数名称: symlink

函数语法: symlink(target, src1, src2, ..., srcN)

参数详解: target-------------------字符串,符号链接的目标

srcX       ---------------------字符串,要创建的符号链接的目标点

作用解释: 在创建新的符号链接之前,要断开已经存在的符号链接

函数示例: symlink("toolbox", "/system/bin/ps");建立指向toolbox的符号链接/system/bin/ps

 

函数名称: set_perm

函数语法: set_perm(uid, gid, mode, file1, file2, ..., fileN)

参数详解: uid----------------------用户ID(user id)

Gid----------------------用户组ID(group id)

Mode--------------------权限模式(permission mode)

fileX---------------------要设置许可的文件(file to set permission on)

作用解释: 设置单个文件或一系列文件的权限,最少指定1个文件,前4个参数是必须的

函数示例: set_perm(0,2000,0550, "system/etc/init.goldfish.sh");设置手机system中的etc/init.goldfish.sh的用户为root,用户组为shell,所有者以及所属用户组成员可以进行读取和执行操作,其他用户无操作权限)

这里0代表用户为root 2000代表用户组为shell 我们来说明0550这组数据,这组数据的最后三位550,分别代表“所有者\组用户\其他用户”的权限,也就是我们在RE管理中“用户\群组\其他”三行。我们以XXX来表示这三组权限,其中: ×=4 读的权限 ×=2 写的权限 ×=1 执行的权限 我们必须首先了解用数字表示的属性的含义:0表示没有权限,1表示可执行权限,2表示可写权限,4表示可读权限,然后将其相加。所以数字属性的格式应为3个从0到7的八进制数。 例如,如果想让某个文件的属主有"读/写"二种权限,需要把4(可读)+2(可写)=6(读/写)。若要rwx属性则4+2+1=7;若要rw-属性则4+2=6;若要r-x属性则4+1=5。 常用修改权限的命令: Set_perm 0 0 0600 ××× (只有所有者有读和写的权限) Set_perm 0 0 0644 ××× (所有者有读和写的权限,组用户只有读的权限) Set_perm 0 0 0700 ××× (只有所有者有读和写以及执行的权限) Set_perm 0 0 0666 ××× (每个人都有读和写的权限) Set_perm 0 0 0777 ××× (每个人都有读和写以及执行的权限)

函数名称: set_perm_recursive

函数语法: set_perm_recursive(uid, gid, dirmode, filemode, dir1, dir2, ...dirN)

参数详解: uid----------------------用户ID(user id)

Gid----------------------用户组ID(group id)

Dirmode----------------指定目录内的目录的权限

Filemode---------------指定目录内的文件的权限

dirX---------------------要设置权限的目标

作用解释: 设置单个目录或一系列目录的里面的所有文件的权限,最少指定1个目录,5个参数都是必须的

函数示例: set_perm_recursive 0 0 0755 0644 SYSTEM:app;设置手机system/app文件夹及其中文件的用户为root,用户组为root,app文件夹权限为所有者可以进行读、写、执行操作,其他用户可以进行读取和执行操作,其中的文件的权限为所有者可以进行读写操作,其他用户可以进行读取操作

 

函数名称: getprop

函数语法: getprop(key)

参数详解: key---------------------字符串,想要系统返回的属性

作用解释: 这个函数是用来返指定的属性的值。它是用来从build.props文件中查询手机的信息的。

函数示例

 

函数名称: write_raw_image

函数语法: write_raw_image(file, partition)

参数详解: file----------------------字符串,要读取的Img源文件

Partition-----------------字符串,要写入Img文件的目标分区

作用解释: 这个函数是用来写Img文件到分区

函数示例: write_raw_image("/tmp/boot.img", "boot")将yaffs2格式的boot包直接写入boot分区

 

函数名称: apply_patch

函数语法: apply_patch(srcfile, tgtfile, tgtsha1, tgtsize, sha1_1, patch_1, ..., sha1_x, patch1_x)

参数详解: srcfile-------------------字符串,要打补丁的源文件(要读入的文件)

Tgtfile-------------------字符串,补丁文件要写入的目标文件

tgtsha1-----------------字符串,写入补丁文件的目标文件的sha1哈希值

sha1_x------------------字符串,要写入目标文件的补丁数据的sha1哈希值

patch1_x----------------字符串,实际上应用到目标文件的补丁

作用解释: 这个函数是用来打补丁到文件。

函数示例

 

函数名称: apply_patch_check

函数语法: apply_patch_check(file, sha1_1, ..., sha1_x)

参数详解: file----------------------字符串,要检查的文件

sha1_x------------------要检查的哈希值

作用解释: 检查文件是否已经被打补丁,或者能不能被打补丁。需要检查“applypatch_check ”函数调用的源代码。

函数示例:

 

函数名称: apply_patch_space

函数语法: apply_patch_space(bytes)

参数详解: bytes-------------------检查的字节的数字

作用解释: 检查缓存来确定是否有足够的空间来写入补丁文件并返回一些数据。

函数示例:

 

函数名称: read_file

函数语法: read_file(filename)

参数详解: filename----------------字符串,要读取内容的文件名

作用解释: 这个函数返回文件的内容

函数示例:

 

函数名称: sha1_check

函数语法: sha1_check(data) sha1_check(data, sha1_hex, ..., sha1_hexN)

参数详解: data---------------------要计算sha1哈希值的文件的内容-必须是只读文件格式

sha1_hexN--------------文件数据要匹配的特定的十六进制sha1_hex哈希值字符串

作用解释: 如果只指定data参数,这个函数返回data参数的十六进制sha1_hex哈希值字符串。其他参数用来确认你检查的文件是不是列表中的哈希值的一个。它返回匹配的哈希值,或者在没有匹配任何哈希值时返回空。

函数示例:

 

函数名称: ui_print

函数语法: ui_print(msg1, ..., msgN)

参数详解: msg----------------------字符串,要处理过程中输出给用户的信息

作用解释: 在脚本运行的时候,在控制台显示的信息。最少要指定1个参数,你可以指定额外的msg参数,并且它们会连接起来输了

函数示例: ui_print("It's ready!");屏幕打印It's ready!

 

函数名称: run_program

函数语法: run_program(prog, arg1, .., argN)

参数详解: prog--------------------字符串,要执行的程序

argN--------------------字符串,要执行的程序的运行参数

作用解释: 以指定的参执行程序

函数示例: run_program("/system/xbin/installbusybox.sh");运行installbusybox.sh脚本文件

 

函数名称: ifelse

函数语法: ifelse(condition, truecondition, falsecondition)

参数详解: condition----------------要运算的表达式

Truecondition-----------当值为True时执行的 Edify脚本块

Falsecodnition-----------当值为False时执行的 Edify脚本块

作用解释: 这是If-then结构的 Edify脚本语言。在真条件或非条件下语句可以是单条Edify命令或者脚本块。脚本块可以用圆括号来界定,用分号来隔开。

函数示例:

 

函数名称: abort

函数语法: abort()

参数详解: 没有参数

作用解释: 中止脚本执行

函数示例:

 

函数名称: assert

函数语法: assert(condition)

参数详解: condition---------------boolean

作用解释: 如果condition参数的计算结果为False,则停止脚本执行,否则继续执行脚本

函数示例: assert(package_extract_file("boot.img","/tmp/boot.img"),write_raw_image("/tmp/boot.img","boot"),delete("/tmp/boot.img"))

执行package_extract_file,如果不返回错误则执行write_raw_image,如果write_raw_image不出错则执行delete

http://blog.csdn.net/tody_guo/article/details/7948083

 

相关文章
|
10月前
|
Java Android开发
Java、Android 新建类自动添加头部注释以及如何添加函数注释模板和快捷键
Java、Android 新建类自动添加头部注释以及如何添加函数注释模板和快捷键
|
12月前
|
Java 编译器 Android开发
Android C++系列:C++11函数特殊特性
在Python中函数有默认参数等,在C++11中我们发现C++也支持了默认参数;还有C++特有的内联函数、constexpr函数等知识都有不少细节,本文对这些知识做详细介绍。
91 0
|
12月前
|
存储 IDE 编译器
Android C++系列:函数返回值注意事项
函数返回值就是使用return语句终止正在执行的函数,看是很简单的问题有什么说的呢?因为越是简单的问题里面越是有一些不易发现的坑。
72 0
|
12月前
|
编译器 Android开发 C++
Android C++系列:数组在函数中注意事项
数组作为函数形参传递的是数组首元素的地址本来是很简单的知识点,但是在具体使用中还会有一些坑需要注意。
107 0
|
12月前
|
C语言 Android开发 C++
Android C++系列:函数知识知多少
函数可以理解为功能的封装,很基础的功能单元,但是因为它虽然看似简单,但是里面涉及了不少知识点和技巧,我们花一篇文章来整理。
95 0
|
12月前
|
网络协议 Unix Linux
Android C++ 系列:Linux Socket 编程(二)网络套接字函数
socket()打开一个网络通讯端口,如果成功的话,就像open()一样返回一个文件描 述符,应用程序可以像读写文件一样用read/write在网络上收发数据,如果socket()调 用出错则返回-1。对于IPv4,domain参数指定为AF_INET。对于TCP协议,type参数指定为 SOCK_STREAM,表示面向流的传输协议。如果是UDP协议,则type参数指定为SOCK_DGRAM,表 示面向数据报的传输协议。protocol参数的介绍从略,指定为0即可。
152 0
|
12月前
|
安全 Java 程序员
Android C++系列:C++最佳实践1虚函数
C++多态的核心技术基础就是虚函数,虚函数允许我们使用同样的基类指针调用同一个方法的不同实现版本。我们Android使用Java开发过程中,方法重写技术自动实现了多态,C++角度可能更繁琐一些,本文从Java程序员思维角度来阐述C++虚函数及开发过程一些准则。
64 0
|
12月前
|
网络协议 Linux Android开发
Android C++ 系列:Linux 常用函数和工具
如果times是非空指针,则存取时间和修改时间被设置为 times所指向的结构中的值。此 时,进程的有效用户ID必须等于该文件的所有者 ID,或者进程必须是一个超级用户进程。对 文件只具有写许可权是不够的
93 0
|
Android开发
Android 重写TextView的onDraw函数遇坑记
Android 重写TextView的onDraw函数遇坑记
155 0
Android 重写TextView的onDraw函数遇坑记
|
Java 编译器 API
Android使用NDK(从java调用本地函数'JNI')
Android使用NDK(从java调用本地函数'JNI')
190 0
Android使用NDK(从java调用本地函数'JNI')