Edify语法简介(Updater-Script).doc

Edify语法简介(Updater-Script) 翻译:Kawvin这是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 或 ext4partition_type-MTD 或 EMMClocation-分区(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 或 ext4partition_type-字符串, MTD 或 EMMClocation-字符串, 分区(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代表用户为root2000代表用户组为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-字符串，想要系统返回的属性作用解释: 这个函数是用来返指定的属性的值。它是用来从ps文件中查询手机的信息的。函数示例: 函数名称: 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(Its ready!);屏幕打印Its ready!函数名称: run_program函数语法: run_program(prog, arg1, ., argN)参数详解: prog-字符串，要执行的程序argN-字符串，要执行的程序的运行参数作用解释: 以指定的参执行程序函数示例: run_program(/system/xbin/installbusybox.sh);运