跳到主要內容

使用JNA存取Windows Share

Introduction

之前曾study過WinAPI去新增Share資料夾與刪除Share資料夾。基於不想使用呼叫外部程式的方式，選擇透過JNA去達到我的需求。而4.1.0的JNA還沒實作我想要的這些功能，就自己來搞定了。

How to?

首先實作存取共享資訊的結構SHARE_INFO_2，除了這個外，其餘的可以參考link。你可以根據需求去實作你所需要的。

package org.tonylin.util.jna;
 
import java.util.Arrays;
import java.util.List;
 
import com.sun.jna.Pointer;
import com.sun.jna.Structure;
import com.sun.jna.WString;
 
/** 
 *  @see https://msdn.microsoft.com/en-us/library/bb525408(v=vs.85).aspx
 *  @author TonyLin 
 */
public class SHARE_INFO_2 extends Structure {
 
	class ByReference implements Structure.ByReference { }
 
	public WString shi2_netname;
	public int shi2_type;
	public WString shi2_remark;
	public int shi2_permissions;
	public int shi2_max_uses;
	public int shi2_current_uses;
	public WString shi2_path;	
	public WString shi2_passwd;
 
	public SHARE_INFO_2(){
 
	}
 
	public SHARE_INFO_2(Pointer p){
		super(p);
	}
 
	@Override
	protected List getFieldOrder() {
		return Arrays.asList("shi2_netname", "shi2_type", "shi2_remark", "shi2_permissions", "shi2_max_uses", "shi2_current_uses", "shi2_path", "shi2_passwd");
	}
 
}

我們所需要的API都在Netapi32函式庫中，我們基於原本JNA已有的Netapi32去擴充:

package org.tonylin.util.jna;
 
import com.sun.jna.Native;
import com.sun.jna.WString;
import com.sun.jna.platform.win32.Netapi32;
import com.sun.jna.ptr.IntByReference;
import com.sun.jna.ptr.PointerByReference;
import com.sun.jna.win32.W32APIOptions;
 
/**
 * @see https://msdn.microsoft.com/en-us/library/bb525393(v=vs.85).aspx
 * @author TonyLin
 */
public interface Netapi32Ext extends Netapi32 {
	Netapi32Ext INSTANCE = (Netapi32Ext) Native.loadLibrary("Netapi32",
			Netapi32Ext.class, W32APIOptions.UNICODE_OPTIONS);
 
	/**
	 * @see https://msdn.microsoft.com/en-us/library/bb525384(v=vs.85).aspx
	 * 
	 * @param servername
	 * @param level
	 * @param buf
	 * @param parm_err
	 * @return
	 */
	public int NetShareAdd(String servername, int level, SHARE_INFO_2 buf, IntByReference parm_err);
 
	/**
	 * @see https://msdn.microsoft.com/en-us/library/bb525386(v=vs.85).aspx
	 * 
	 * @param servername
	 * @param device
	 * @param reserved
	 * @return
	 */
	public int NetShareDel(WString servername, WString device, int reserved);
 
 
	/**
	 * @see https://msdn.microsoft.com/en-us/library/bb525388(v=vs.85).aspx
	 * 
	 * @param servername
	 * @param netname
	 * @param level
	 * @param bufptr
	 * @return
	 */
	public int NetShareGetInfo(WString servername, WString netname, int level, PointerByReference bufptr);
}

Unit Test

針對新增、刪除與查詢做測試，必須使用admin的權限去啟動eclipse，才能正常執行。

package org.tonylin.util.jna;
 
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNull;
 
import java.io.File;
 
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.tonylin.util.io.FileUtil;
 
import com.sun.jna.WString;
import com.sun.jna.platform.win32.Kernel32Util;
import com.sun.jna.ptr.IntByReference;
import com.sun.jna.ptr.PointerByReference;
 
public class Netapi32ExtTest {
 
	private String sharedFolder = "/TEST_SHARE";
	private File shareFolder = new File(sharedFolder);
	static private String SHARE_NAME = "TEST_SHARE";
 
	@Before
	public void setup() {
		FileUtil.createFolder(sharedFolder);
	}
 
	@After
	public void teardown() {
		Netapi32Ext.INSTANCE.NetShareDel(null, new WString(
				SHARE_NAME), 0);
		FileUtil.deleteFile(sharedFolder);
	}
 
	@Test
	public void testNetShareGetInfo() {
		System.out.println("-> testNetShareGetInfo");
 
		PointerByReference buf = new PointerByReference();
		try {
			int ret = Netapi32Ext.INSTANCE.NetShareGetInfo(null, new WString(
					SHARE_NAME), 2, buf);
			System.out.println(Kernel32Util.formatMessage(ret));
			if (ret != 0) {
				assertEquals(0x906, ret); // NERR_NetNameNotFound
				assertNull(buf.getValue());
			} else {
				SHARE_INFO_2 shareInfo = new SHARE_INFO_2(buf.getValue());
				shareInfo.read();
 
				assertEquals(SHARE_NAME, shareInfo.shi2_netname);
				assertEquals(0, shareInfo.shi2_permissions);
			}
		} finally {
			Netapi32Ext.INSTANCE.NetApiBufferFree(buf.getValue());
		}
	}
 
	@Test
	public void testNetShareDel() {
		System.out.println("-> testNetShareDel");
		SHARE_INFO_2 buf = getShareInfo();
		IntByReference intRef = new IntByReference();
		 Netapi32Ext.INSTANCE.NetShareAdd(null, 2, buf, intRef);
 
		 // delete
		int ret = Netapi32Ext.INSTANCE.NetShareDel(null, new WString(
				SHARE_NAME), 0);
 
		System.out.println(Kernel32Util.formatMessage(ret));
		assertEquals(0 , ret);
 
		// re-del
		ret = Netapi32Ext.INSTANCE.NetShareDel(null, new WString(
					SHARE_NAME), 0);
 
		System.out.println(Kernel32Util.formatMessage(ret));
		 assertEquals(0x00000906, ret);
	}
 
	private SHARE_INFO_2 getShareInfo(){
		SHARE_INFO_2 buf = new SHARE_INFO_2();
		buf.shi2_netname = new WString(SHARE_NAME);
		buf.shi2_type = 0;
		buf.shi2_remark = new WString(SHARE_NAME);
		buf.shi2_permissions = 0;
		buf.shi2_max_uses = 4;
		buf.shi2_current_uses = 0;
		buf.shi2_path = new WString(shareFolder.getAbsolutePath());
		buf.shi2_passwd = null; // no passwd
		return buf;
	}
 
	/**
	 * @see Error:
	 *      https://msdn.microsoft.com/en-us/library/cc247101.aspx?f=255&MSPPError
	 *      =-2147217396
	 * 
	 */
	@Test
	public void testNetShareAdd() {
		System.out.println("-> testNetShareAdd");
		SHARE_INFO_2 buf = getShareInfo();
 
		// add
		IntByReference intRef = new IntByReference();
		int ret = Netapi32Ext.INSTANCE.NetShareAdd(null, 2, buf, intRef);
 
		System.out.println(Kernel32Util.formatMessage(ret));
		assertEquals(0, ret);
		assertEquals(0, intRef.getValue());
 
		// re-add
		ret = Netapi32Ext.INSTANCE.NetShareAdd(null, 2, buf, intRef);
		System.out.println(Kernel32Util.formatMessage(ret));
		assertEquals(0x846, ret);
 
		// get info
		PointerByReference pbuf = new PointerByReference();
		try {
			ret = Netapi32Ext.INSTANCE.NetShareGetInfo(null, new WString(
					SHARE_NAME), 2, pbuf);
 
			SHARE_INFO_2 shareInfo = new SHARE_INFO_2(pbuf.getValue());
			shareInfo.read();
 
			System.out.println(Kernel32Util.formatMessage(ret));
			assertEquals(buf.shi2_netname, shareInfo.shi2_netname);
			assertEquals(buf.shi2_type, shareInfo.shi2_type);
			assertEquals(buf.shi2_remark, shareInfo.shi2_remark);
			assertEquals(buf.shi2_permissions, shareInfo.shi2_permissions);
			assertEquals(buf.shi2_max_uses, shareInfo.shi2_max_uses);
			assertEquals(buf.shi2_current_uses, shareInfo.shi2_current_uses);
			assertEquals(buf.shi2_path, shareInfo.shi2_path);
			assertNull(shareInfo.shi2_passwd);
		} finally {
			Netapi32Ext.INSTANCE.NetApiBufferFree(pbuf.getValue());
		}
	}
}

Reference

標籤：

留言

張貼留言

這個網誌中的熱門文章

解決RobotFramework從3.1.2升級到3.2.2之後，Choose File突然會整個Hand住的問題

考慮到自動測試環境的維護，我們很久以前就使用java去執行robot framework。前陣子開始處理從3.1.2升級到3.2.2的事情，主要先把明確的runtime語法錯誤與deprecate item處理好，這部分內容可以參考: link 。 直到最近才發現，透過SeleniumLibrary執行Choose File去上傳檔案的動作，會導致測試案例timeout。本篇文章主要分享心路歷程與解決方法，我也送了一條issue給robot framework: link 。 我的環境如下: RobotFramework: 3.2.2 Selenium: 3.141.0 SeleniumLibrary: 3.3.1 Remote Selenium Version: selenium-server-standalone-3.141.59 首先並非所有Choose File的動作都會hang住，有些測試案例是可以執行的，但是上傳一個作業系統ISO檔案一定會發生問題。後來我透過wireshark去比對新舊版本的上傳動作，因為我使用 Remote Selenium ，所以Selenium會先把檔案透過REST API發送到Remote Selenium Server上。從下圖我們可以發現，在3.2.2的最後一個TCP封包，比3.1.2大概少了500個bytes。 於是就開始了我trace code之路。包含SeleniumLibrary產生要送給Remote Selenium Server的request內容，還有HTTP Content-Length的計算，我都確認過沒有問題。 最後發現問題是出在socket API的使用上，就是下圖的這支code: 最後發現可能因為開始使用nio的方式送資料，但沒處理到尚未送完的資料內容，而導致發生問題。加一個loop去做計算就可以解決了。 最後我有把解法提供給robot framework官方，在他們出新的版本之前，我是將改完的_socket.py放在我們自己的Lib底下，好讓我們測試可以正常進行。(shutil.py應該也是為了解某個bug而產生的樣子..)
張貼留言
閱讀完整內容

Show NIC selection when setting the network command with the device option

 Problem  在answer file中設定網卡名稱後，安裝時會停在以下畫面: 所使用的command參數如下: network --onboot = yes --bootproto =dhcp --ipv6 =auto --device =eth1 Diagnostic Result 這樣的參數，以前試驗過是可以安裝完成的。因此在發生這個問題後，我檢查了它的debug console: 從console得知，eth1可能是沒有連接網路線或者是網路太慢而導致的問題。後來和Ivy再三確認，有問題的是有接網路線的網卡，且問題是發生在activate階段: Solution 我想既然有retry應該就有次數或者timeout限制，因此發現在Anaconda的說明文件中( link )，有提到dhcptimeout這個boot參數。看了一些人的使用範例，應該是可以直接串在isolinux.cfg中，如下: default linux ksdevice = link ip =dhcp ks =cdrom: / ks.cfg dhcptimeout = 90 然而我在RHEL/CentOS 6.7與6.8試驗後都無效。 因此我就拿了顯示的錯誤字串，問問Google大師，想找一下Anaconda source code來看一下。最後找到別人根據Anaconda code修改的版本: link ，關鍵在於setupIfaceStruct函式中的setupIfaceStruct與readNetConfig: setupIfaceStruct: 會在dhcp時設定dhcptimeout。 readNetConfig: 在writeEnabledNetInfo將timeout寫入dhclient config中；在wait_for_iface_activation內會根據timeout做retry。 再來從log與code可以得知，它讀取的檔案是answer file而不是boot command line。因此我接下來的測試，就是在answer file的network command上加入dhcptimeout: network --onboot = yes --bootproto =dhcp --ipv6 =auto --device =eth1 --...
張貼留言
閱讀完整內容

Robot Framework - Evaluate該怎麼用?

Evaluate該怎麼用? 前言 Builtin的RobotFramework Library提供了Evaluate Keyword。它所提供的功能是「執行Python描述句」。但實際上到底有什麼用途呢?原本我僅僅拿來將string轉為int的功用，經過一些查詢與試驗，我將心得整理給大家。 Builtin Builtin的function可以參考Library Doc for Evaluate。我以有使用過的function做說明。 數字轉換 Python提供了int、long、float與complex等function讓你可以將字串轉為數字，也可以透過它們做四則運算。首先以字串轉數字為例，我將8設於${num_str}中，再透過Evaluate+int轉為數字。這裡必須注意的是: 「int()中放變數必須以單引號'括起」。否則，假如你設定的數字為08，在轉換int時會出現Syntax Error。 ${num_str} | Set Variable | 8 ${num} | Evaluate | int('${num_str}') 其中int與long的第二個參數為base，這是根據你的input所決定: Comment | num = 9 ${num} | Evaluate | int('11', 8) Comment | num = 11 ${num} | Evaluate | int('11', 10) Comment | num = 17 ${num} | Evaluate | int('11', 16) 其它還有像bin、oct、hex，可以將整數轉為2、8、16進位。 運算 四則運算: 直接將運算子加上即可: ${num} | Evaluate | int('${hour}')*60 + int('${min}') 指數: 可以用pow。以下面兩個例子來說，第一個是2的3次方為8，第二個是2的3次方再mod 7為1。需注意的是: 「傳入值必須是數字不可為字串」。 ${num} | Evaluate | pow(2,3) ${num} | Evaluate | pow(2,3,7) 取最大最小值: 使用max/min，可以選擇丟一個array的方式...
張貼留言
閱讀完整內容