<?xml version="1.0"?>
<!-- Build file to generate Permission Checker RPC Plugin soap stubs -->
<project name="hello-permsoap" default="generate-axis-client-code" basedir=".">

	<!-- Set these three properties. 
	     conf-jars: set this property to any local confluence WEB-INF/lib directory 
	     gen-source-java-dir: set this prop to the directory you wish the soap stub classes to be generated into.
	          If you do not change this setting they will be sent to './soap-generated-source' 
 	          If the directory does not exist it will be created.
	     perm-wsdl: Set this to your confluence's installed permcheck.wsdl
	-->
	<property name="confjars" value="/Users/laura/Code/Confluence/confluence-std-2.6.2/confluence/WEB-INF/lib/"/>
	<property name="gen-source-java-dir" value="soap-generated-source"/>
	<property name="perm-wsdl" value="http://localhost:8082/rpc/soap/permcheck.wsdl"/>

	<!-- Properties you don't need to set. -->
	<property name="conf-wsdl" value="http://localhost:8082/rpc/soap-axis/confluenceservice-v1?wsdl" /> <!-- example. not used -->
	<property name="perm-package" value="com.atlassian.confluence.plugins.rpc.permcheck"/>
	<property name="conf-package" value="com.atlassian.confluence.rpc"/> <!-- example, not used -->
	<property name="wsdl" value="${perm-wsdl}"/>
	<property name="package" value="${perm-package}"/>
	

	<target name="generate-axis-client-code">
         <mkdir dir="${gen-source-java-dir}"/>
         <java classname="org.apache.axis.wsdl.WSDL2Java" fork="true">
         	   <arg line="${wsdl} -p ${package} --output ${gen-source-java-dir}"/>
         		<classpath>
         			<fileset dir="${confjars}">
         				<include name="**/*.jar"/>
         			</fileset>
         		</classpath>
         </java>
	</target>
</project>

public String getUrl();
public String getKey();
public String getName();
public String getType();

String getTitle();
long getId();
String getSpace();
long getParentId();
String getUrl();
int getPermissions(); 

String getTitle()
long getId()
String getSpace()
long getParentId()
String getUrl()
int getPermissions()
String getContentStatus()
String getCreator()
String getModifier()
int getVersion()
Calendar getCreated()
Calendar getModified()
String getContent()

        /**
	 * @return soap service for the Confluence Remote API
	 * Note: You'll need to the auto-generate the soap service stubs, using axis's WSDL2Java
	 */
	private PermissionChecker_PortType getPermissionCheckerSoapService() {
		
		//get the soap service, using the WSDL2Java auto-generated classes
		PermissionChecker_PortType stub = null;   
		try {
			//need to use the WSDL2java auto-generated locator to get the service
			PermissionChecker_ServiceLocator locator = new PermissionChecker_ServiceLocator();
			//now we actually can get the service!
			stub = locator.getPermissionChecker();
		} catch (ServiceException e) {
			e.printStackTrace();
		}
		return stub;
	}

        /**
	 * gets the login token from Confluence's Remote API via Soap
	 * You'll need to generate the stubs with axis's WSDL2Java.
	 * @param username
	 * @param password 
	 * @return login token
	 */
	private String getLoginToken(String username, String password) {
                //get the soap object
		PermissionChecker_PortType service = getPermissionCheckerSoapService();//see getPermissionCheckerSoapService example
                String loginToken = null;
		try {
			//make the soap call
			loginToken = service.login(username, password);
		} catch (Exception e) {
			e.printStackTrace();
		}
		return loginToken;
	}

        private static final String TESTSPACE = "Serenity"; 		//your test spacekey
	private static final String TESTPAGE = "Testpage";		//your test page that the user has complete access to
	private static final String TEST_NOEDIT = "Testpage No Edit";	//your test page that the user can see but not edit
	private static final String TEST_NOVIEW = "Testpage No View";	//your test page that the user has no access to
	private static final String TEST_NOPAGE = "Testpage No Page";	//page that doesn't exist
	
        Logger log = Logger.getLogger(this.getClass());

	private void testHasViewPermission(String loginToken, String url, String username) {
		
		PermissionChecker_PortType service = getPermissionCheckerSoapService();//see getPermissionCheckerSoapService example
		try {
			//page user has all access to
			String page = TESTPAGE;
			String spacekey = TESTSPACE;
			String pageurl = createConfluencePageUrl(url, spacekey, page);  
			boolean has = service.hasViewPermission(loginToken, pageurl, username);
			log.debug("Username '" + username + "' " + (has?"HAS":"does NOT have") + " view access to '" + page + "'");

			//page user can view but not edit
			page = TEST_NOEDIT;
			pageurl = createConfluencePageUrl(url, spacekey, page); 
			has = service.hasViewPermission(loginToken, pageurl, username);
			log.debug("Username '" + username + "' " + (has?"HAS":"does NOT have") + " view access to '" + page + "'");
						
			//page user can't view or edit
			page = TEST_NOVIEW;
			pageurl = createConfluencePageUrl(url, spacekey, page); 
			has = service.hasViewPermission(loginToken, pageurl, username);
			log.debug("Username '" + username + "' " + (has?"HAS":"does NOT have") + " view access to '" + page + "'");
			
			//case doesn't appear to matter
			page = TESTPAGE.toUpperCase();
			pageurl = createConfluencePageUrl(url, spacekey, page); 
			has = service.hasViewPermission(loginToken, pageurl, username);
			log.debug("Username '" + username + "' " + (has?"HAS":"does NOT have") + " view access to '" + page + "'");
			
			//page that doesn't exist is handled as if the user doesn't have access to the page
			page = TEST_NOPAGE;
			pageurl = createConfluencePageUrl(url, spacekey, page); 
			has = service.hasViewPermission(loginToken, pageurl, username);
			log.debug("Username '" + username + "' " + (has?"HAS":"does NOT have") + " view access to '" + page + "'");
			
		} catch (Exception e) {
			e.printStackTrace();
		}
		
	}

	/**
	 * @param url confluence location. example: localhost:8082
	 * @param spacekey confluence space where page resides. 
	 * @param page confluence page. example: Testpage Test 
	 * @return url to confluence page. example: http://localhost:8082/display/spacekey/Testpage+Test
	 */
	private String createConfluencePageUrl(String url, String spacekey, String page) {
		return "http://" + url + "/display/" + spacekey + "/" + 
			page.replaceAll(" ", "+");
	}

	private static final String TESTSPACE = "Serenity"; 		//your test spacekey
	private static final String TESTPAGE = "Testpage";		//your test page that the user has complete access to
	private static final String TEST_NOEDIT = "Testpage No Edit";	//your test page that the user can see but not edit
	private static final String TEST_NOVIEW = "Testpage No View";	//your test page that the user has no access to

	private void testHasMultPermissions(String loginToken, String url, String username) {
		
		PermissionChecker_PortType service = getPermissionCheckerSoapService();//see getPermissionCheckerSoapService example
		String[] urls = {
				createConfluencePageUrl(url, TESTSPACE, TESTPAGE),    //see hasViewPermission example above
				createConfluencePageUrl(url, TESTSPACE, TEST_NOEDIT),
				createConfluencePageUrl(url, TESTSPACE, TEST_NOVIEW),
		};
		try {
			boolean[] viewBooleans = service.hasViewPermissions(loginToken, urls, username);
			for (int i = 0; i < viewBooleans.length; i++) {
				boolean has = viewBooleans[i];
				String page = urls[i];
				log.debug("Username '" + username + "' " + (has?"HAS":"does NOT have") + " view privileges to '" + page+ "'");
			}
		} catch (Exception e) {
			e.printStackTrace();
		}
		
	}

	private static final String TESTSPACE = "Serenity"; 			//your test spacekey
	private static final String TESTPAGE = "Testpage";				//your test page that the user has complete access to

	private void testHasEditPermission(String loginToken, String url, String username) {
		
		PermissionChecker_PortType service = getPermissionCheckerSoapService(); //see getPermissionCheckerSoapService example
		try {
			String page = TESTPAGE;
			String pageurl = createConfluencePageUrl(url, TESTSPACE, page); //see hasViewPermission example
			boolean has = service.hasEditPermission(loginToken, pageurl, username);
			log.debug("Username '" + username + "' " + (has?"HAS":"does NOT have") + " edit privileges to '" + page+ "'");
		} catch (Exception e) {
			e.printStackTrace();
		}
		
	}

        private static final int TESTPAGEID = 47611925;					//your test page's page id
	private static final int PAGEID_NOEDIT = 47611927;				//no edit's page's id

	private void testHasEditPermissionById(String loginToken, String url, String username) {	
		PermissionChecker_PortType service = getPermissionCheckerSoapService();//see getPermissionCheckerSoapService example
		try {
			//testing id method
			long id = TESTPAGEID;
			boolean has = service.hasEditPermissionById(loginToken, id, username); //same as TestPage, so should be true.
			log.debug("Username '" + username + "' " + (has?"HAS":"does NOT have") + " edit privileges to page with id '" + id + "'");

			id = PAGEID_NOEDIT;
			has = service.hasEditPermissionById(loginToken, id, username); //same as TestPage, so should be true.
			log.debug("Username '" + username + "' " + (has?"HAS":"does NOT have") + " edit privileges to page with id '" + id + "'");


		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	private static final String TESTSPACE = "Serenity"; 		//your test spacekey
	private static final String TESTPAGE = "Testpage";		//your test page that the user has complete access to
	private static final String TEST_NOEDIT = "Testpage No Edit";	//your test page that the user can see but not edit
	private static final String TEST_NOVIEW = "Testpage No View";	//your test page that the user has no access to

	private void testHasMultPermissions(String loginToken, String url, String username) {
		
		PermissionChecker_PortType service = getPermissionCheckerSoapService();//see getPermissionCheckerSoapService example
		String[] urls = {
				createConfluencePageUrl(url, TESTSPACE, TESTPAGE),    //see hasViewPermission example above
				createConfluencePageUrl(url, TESTSPACE, TEST_NOEDIT),
				createConfluencePageUrl(url, TESTSPACE, TEST_NOVIEW),
		};
		try {
			boolean[] editBooleans = service.hasEditPermissions(loginToken, urls, username);
			for (int i = 0; i < editBooleans.length; i++) {
				boolean has = editBooleans[i];
				String page = urls[i];
				log.debug("Username '" + username + "' " + (has?"HAS":"does NOT have") + " edit privileges to '" + page+ "'");
			}
		} catch (Exception e) {
			e.printStackTrace();
		}
		
	}

	private void testGetSpacesForUser(String loginToken, String username) {
		//method sig: RemoteSpaceSummary[] getSpacesForUser(String token, String username) throws RemoteException;
		
		//NOTE: doesn't appear to handle Personal Spaces
		PermissionChecker_PortType service = getPermissionCheckerSoapService(); //see getPermissionCheckerSoapService example 
		com.atlassian.confluence.plugins.rpc.permcheck.RemoteSpaceSummary[] spacesForUser = null;
		try {
			spacesForUser = service.getSpacesForUser(loginToken, username);
		} catch (Exception e) {
			e.printStackTrace();
		}
		
		if (spacesForUser != null) {
			log.debug("User '" + username +"' has access to these spaces: ");
			for (com.atlassian.confluence.plugins.rpc.permcheck.RemoteSpaceSummary summary : spacesForUser) {
				log.debug("   * " + summary.getName() + " (" + summary.getKey() + ")");
			}
		}
		
	}

	private static final String TESTSPACE = "Serenity"; 			//your test spacekey
	private void testGetPagesForUser(String loginToken, String username) {

		String spacekey = TESTSPACE;
		PermissionChecker_PortType service = getPermissionCheckerSoapService();//see getPermissionCheckerSoapService example
		com.atlassian.confluence.plugins.rpc.permcheck.RemotePageSummary[] pagesForUser = null;
		try {
			pagesForUser = service.getPagesForUser(loginToken, spacekey, username);
		} catch (Exception e) {
			e.printStackTrace();
		}
		if (pagesForUser == null) 
			log.error("Problem: no pages from getPagesForUser.");
		else {
			log.debug("User '" + username +"' has access to these pages: ");
			int i = 0; 
			int max = 5; //only show the first N pages
			for (com.atlassian.confluence.plugins.rpc.permcheck.RemotePageSummary summary : pagesForUser) {
				if (i++ >= max) break;
				log.debug("\n" +
						  "   title = " + summary.getTitle() + "\n" +
						  "   id = " + summary.getId() +"\n" +
						  "   space = " + summary.getSpace() + "\n" +
						  "   parentId = " + summary.getParentId() + "\n" +
						  "   url = " + summary.getUrl() + "\n" +
						  "   permissions = " + summary.getPermissions() + "\n");
						  
			}
		}
	}

	private static final String TESTSPACE = "Serenity"; 			//your test spacekey
	private static final String TESTPAGE = "Testpage";		//your test page that the user has complete access to
	private static final String TEST_NOVIEW = "Testpage No View";	//your test page that the user has no access to
	private static final String TEST_NOPAGE = "Testpage No Page";	//page that doesn't exist

	private void testGetPageForUser(String loginToken, String username) {
		String spacekey = TESTSPACE;
		String pagename = TESTPAGE;
		PermissionChecker_PortType service = getPermissionCheckerSoapService();//see getPermissionCheckerSoapService example
		
		//using pagename and spacekey
		com.atlassian.confluence.plugins.rpc.permcheck.RemotePage pageForUser = null;
		try {
			pageForUser = service.getPageForUser(loginToken, spacekey, pagename, username);
		} catch (Exception e) {
			e.printStackTrace();
		}
		if (pageForUser == null) log.error("Page was null");
		else {
			log.debug("\n" +
					  "   title = " + pageForUser.getTitle() + "\n" +
					  "   id = " + pageForUser.getId() +"\n" +
					  "   space = " + pageForUser.getSpace() + "\n" +
					  "   parentId = " + pageForUser.getParentId() + "\n" +
					  "   url = " + pageForUser.getUrl() + "\n" +
					  "   permissions = " + pageForUser.getPermissions() + "\n" +
					  "   content status = " + pageForUser.getContentStatus() + "\n" +
					  "   creator = " + pageForUser.getCreator() + "\n" +
					  "   last modifier = " + pageForUser.getModifier() + "\n" +
					  "   version = " + pageForUser.getVersion() + "\n" +
					  "   created date = " + pageForUser.getCreated() + "\n" +
					  "   last modified date = " + pageForUser.getModified() + "\n" +
					  "   content = \n" + pageForUser.getContent() + "\n");
		}
		
		//if user does not have access
		pagename = TEST_NOVIEW;
		pageForUser = null;
		try {
			pageForUser = service.getPageForUser(loginToken, spacekey, pagename, username);
		} catch (RemoteException e) {
			e.printStackTrace();
		} catch (java.rmi.RemoteException e) {
			log.debug("User '" + username +"' does not have view access for page '"+pagename+"'. An exception was triggered successfully.");
		}
		
		//what happens if the page does not exist
		pagename = TEST_NOPAGE;
		pageForUser = null;
		try {
			pageForUser = service.getPageForUser(loginToken, spacekey, pagename, username);
		} catch (RemoteException e) {
			e.printStackTrace();
		} catch (java.rmi.RemoteException e) {
			log.debug("Page '"+pagename+"' does not exist. An exception was triggered successfully.");
		}
	}

	private static final int TESTPAGEID = 47611925;					//your test page's page id
	private void testGetPageForUser(String loginToken, String username) {
		long pageid = TESTPAGEID;
		com.atlassian.confluence.plugins.rpc.permcheck.RemotePage pageForUser = null;
		PermissionChecker_PortType service = getPermissionCheckerSoapService();//see getPermissionCheckerSoapService example
		try {
			pageForUser = service.getPageByIdForUser(loginToken, pageid, username);
		} catch (Exception e) {
			log.error("Problem getting page. " + pageid);
		}
		if (pageForUser == null) log.error("Page was null");
		else {
			log.debug("\n" +
					  "   title = " + pageForUser.getTitle() + "\n" +
					  "   id = " + pageForUser.getId() +"\n" +
					  "   space = " + pageForUser.getSpace() + "\n" +
					  "   parentId = " + pageForUser.getParentId() + "\n" +
					  "   url = " + pageForUser.getUrl() + "\n" +
					  "   permissions = " + pageForUser.getPermissions() + "\n" +
					  "   content status = " + pageForUser.getContentStatus() + "\n" +
					  "   creator = " + pageForUser.getCreator() + "\n" +
					  "   last modifier = " + pageForUser.getModifier() + "\n" +
					  "   version = " + pageForUser.getVersion() + "\n" +
					  "   created date = " + pageForUser.getCreated() + "\n" +
					  "   last modified date = " + pageForUser.getModified() + "\n" +
					  "   content = \n" + pageForUser.getContent() + "\n");
		}
	}

	private static final String TESTSPACE = "Serenity"; 			//your test spacekey
	private static final int TESTPAGEID = 47611925;				//your test page's page id
	private static final int PAGEID_NOVIEW = 47611926;			//no view's page's id
	private void testRenderContentAsUser(String loginToken, String username) {
		String spacekey = TESTSPACE;
		long pageid = TESTPAGEID;
		String newContent = ""; //if newContent == "", then the existing content is rendered. if "new" (read preview) content is provided, then it's rendered as if there was new content, BUT the page isn't edited.
		PermissionChecker_PortType service = getPermissionCheckerSoapService();//see getPermissionCheckerSoapService example
		
		//testing rendering a simple page user has access to, no params.
		try {
			String rendered = service.renderContentAsUser(loginToken, spacekey, pageid, newContent, username);
			if (rendered == null) log.error("Rendered page was null.");
			else log.debug("\n" + rendered);
		} catch (Exception e) {
			e.printStackTrace();
		}
		
		//testing rendering a page the user does not have access to. Should throw exception
		pageid = PAGEID_NOVIEW;
		try {
			String rendered = service.renderContentAsUser(loginToken, spacekey, pageid, newContent, username);
			log.error("An exception should have been thrown.");
		} catch (Exception e) {
			log.debug("As user does not have access to that page id, a RemoteException was thrown. Test succeeded.");
		}
	}