Merge pull request #2 from ftravaglia/get-html-page

jpflug · web-flow · commit ea7ef87261db · 2019-05-06T09:42:06.000-06:00
Get html page feature
diff --git a/README.md b/README.md
@@ -61,6 +61,14 @@ The page text should be formatted with HTML tags.
 
 ![screenshot of add-page](images/updatepage.png)
 
+
+### Task: Get HTML content
+
+Get the HTML code of a confluence page.
+
+![screenshot of get-html](images/get-html-page.png)
+
+
 ### Server configuration ###
 
 ![screenshot of configuration](images/config.png)
diff --git a/build.gradle b/build.gradle
@@ -5,7 +5,7 @@ plugins {
   id "java"
 }
 
-version = "1.1.0"
+version = "1.2.0"
 
 processResources.configure {
   filter ReplaceTokens, tokens: [
diff --git a/images/get-html-page.png b/images/get-html-page.png
diff --git a/src/main/resources/confluence/ConfluenceClient.py b/src/main/resources/confluence/ConfluenceClient.py
@@ -1,5 +1,5 @@
 #
-# Copyright 2017 XEBIALABS
+# Copyright 2018 XEBIALABS
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 #
@@ -90,6 +90,25 @@ def getPageIdsByTitle(self, spaceKey, pageTitles):
           pageIdList.append(page['id'])
       return pageIdList
 
+    def getPageHtmlByTitle(self, spaceKey, pageTitles):
+      print "Executing getPageHtmlByTitle() in ConfluenceClient\n"
+      pageID = self.getPageIdsByTitle(spaceKey, pageTitles)[0]
+      contentType = "application/json"
+      headers = {'Accept' : 'application/json'}
+      pageList = []
+      pageStr = ''
+      for pageTitle in pageTitles:
+        searchByPageTitleUrl = '/rest/api/content/' + pageID + '?expand=body.storage'
+        response = self.httpRequest.get(searchByPageTitleUrl, contentType=contentType, headers=headers, quotePlus=True)
+        if response.getStatus() not in HTTP_SUCCESS:
+          self.throw_error(response)
+        result = json.loads(response.response)
+        for page in result['body']['storage']['value']:
+          pageStr = pageStr + page
+
+      pageList.append(pageStr)
+      return pageList
+
     def updatePage(self, spaceKey, pageId, pageTitle, pageText):
       print "Executing updatePage() in ConfluenceClient\n"
       contentType = "application/json"
diff --git a/src/main/resources/confluence/ConfluenceClientUtil.py b/src/main/resources/confluence/ConfluenceClientUtil.py
@@ -1,5 +1,5 @@
 #
-# Copyright 2017 XEBIALABS
+# Copyright 2018 XEBIALABS
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 #
diff --git a/src/main/resources/confluence/HttpRequestPlus.py b/src/main/resources/confluence/HttpRequestPlus.py
@@ -1,5 +1,5 @@
 #
-# Copyright 2017 XEBIALABS
+# Copyright 2018 XEBIALABS
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 #
diff --git a/src/main/resources/confluence/__init__.py b/src/main/resources/confluence/__init__.py
@@ -1,5 +1,5 @@
 #
-# Copyright 2017 XEBIALABS
+# Copyright 2018 XEBIALABS
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 #
diff --git a/src/main/resources/confluence/addCommentToWikiPages.py b/src/main/resources/confluence/addCommentToWikiPages.py
@@ -1,5 +1,5 @@
 #
-# Copyright 2017 XEBIALABS
+# Copyright 2018 XEBIALABS
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 #
diff --git a/src/main/resources/confluence/addWikiPages.py b/src/main/resources/confluence/addWikiPages.py
@@ -1,5 +1,5 @@
 #
-# Copyright 2017 XEBIALABS
+# Copyright 2018 XEBIALABS
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 #
diff --git a/src/main/resources/confluence/deleteWikiPages.py b/src/main/resources/confluence/deleteWikiPages.py
@@ -1,5 +1,5 @@
 #
-# Copyright 2017 XEBIALABS
+# Copyright 2018 XEBIALABS
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 #
diff --git a/src/main/resources/confluence/getHtmlPageByTitle.py b/src/main/resources/confluence/getHtmlPageByTitle.py
@@ -0,0 +1,27 @@
+#
+# Copyright 2018 XEBIALABS
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+from confluence.ConfluenceClientUtil import ConfluenceClientUtil
+
+print "Executing getPageHtmlByTitle.py\n"
+
+if confluenceServer is None:
+  print "No server provided\n"
+  sys.exit(1)
+
+credentials = CredentialsFallback(confluenceServer, username, password).getCredentials()
+
+confluenceClient = ConfluenceClientUtil.createConfluenceClient(confluenceServer, credentials['username'], credentials['password'])
+
+pageTitles = [pageTitle]
+pageIdList = confluenceClient.getPageHtmlByTitle(spaceKey, pageTitles)
+
+htmlpage = pageIdList[0]
+
diff --git a/src/main/resources/confluence/updateWikiPages.py b/src/main/resources/confluence/updateWikiPages.py
@@ -1,5 +1,5 @@
 #
-# Copyright 2017 XEBIALABS
+# Copyright 2018 XEBIALABS
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 #
diff --git a/src/main/resources/plugin-version.properties b/src/main/resources/plugin-version.properties
@@ -1,5 +1,5 @@
 #
-# Copyright 2017 XEBIALABS
+# Copyright 2018 XEBIALABS
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 #
diff --git a/src/main/resources/synthetic.xml b/src/main/resources/synthetic.xml
@@ -1,7 +1,7 @@
 <?xml version='1.0' encoding='UTF-8'?>
 <!--
 
-    Copyright 2017 XEBIALABS
+    Copyright 2018 XEBIALABS
 
     Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
@@ -53,5 +53,11 @@
     <property name="newPageText" category="input" />
   </type>
 
+  <type type="confluence.getHtmlPageByTitle" extends="confluence.Task">
+    <property name="spaceKey" category="input" required="true" />
+    <property name="pageTitle" category="input" kind="string" required="true" />
+    <property name="htmlpage"     category="output"/>
+  </type>
+
 </synthetic>
 

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ plugins {`
`5`	`5`	`id "java"`
`6`	`6`	`}`
`7`	`7`
`8`		`-version = "1.1.0"`
	`8`	`+version = "1.2.0"`
`9`	`9`
`10`	`10`	`processResources.configure {`
`11`	`11`	`filter ReplaceTokens, tokens: [`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`#`
`2`		`-# Copyright 2017 XEBIALABS`
	`2`	`+# Copyright 2018 XEBIALABS`
`3`	`3`	`#`
`4`	`4`	`# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:`
`5`	`5`	`#`