Now providing a link to online version of file

Author: dschreij

QOpenScienceFramework/widgets.py

@@ -13,6 +13,7 @@
 from __future__ import unicode_literals
 
 import os
+import re
 import sys
 import json
 import logging
@@ -337,10 +338,6 @@ def __init__(self, manager, tree_widget=None, locale='en_us'):
 		preview_area.addWidget(self.image_space)
 		preview_area.addWidget(self.img_preview_progress_bar)
 
-		# Create a widget that displays the link of the file on OSF
-		self.link_widget = self.__create_link_widget()
-		self.link_widget.hide()
-
 		## Create layouts
 
 		# The box layout holding all elements
@@ -352,8 +349,6 @@ def __init__(self, manager, tree_widget=None, locale='en_us'):
 		info_grid.setSpacing(10)
 		info_grid.addLayout(preview_area)
 		info_grid.addLayout(properties_pane)
-		info_grid.addStretch()
-		info_grid.addWidget(self.link_widget)
 
 		# The widget to hold the infogrid
 		self.info_frame = QtWidgets.QWidget()
@@ -403,26 +398,6 @@ def __init__(self, manager, tree_widget=None, locale='en_us'):
 		self.tree.refreshFinished.connect(self.__tree_refresh_finished)
 
 	### Private functions
-	def __create_link_widget(self):
-		wdgt = QtWidgets.QWidget(self)
-		layout = QtWidgets.QHBoxLayout(wdgt)
-
-		osf_link_label = QtWidgets.QLabel(_(u"Link"))
-		osf_link_label.setStyleSheet('font-weight: bold')
-		self.osf_link_field = QtWidgets.QLabel()
-		copy_icon = QtGui.QIcon.fromTheme('accessories-clipboard', 
-			qta.icon('fa.clipboard'))
-		button_copy_to_clipboard = QtWidgets.QPushButton(copy_icon, 
-			_(u"Copy"))
-		visit_osf_icon = QtGui.QIcon.fromTheme('web-browser', qta.icon('fa.globe'))
-		button_open_in_browser = QtWidgets.QPushButton(visit_osf_icon, 
-			_(u"View online"))
-		layout.addWidget(osf_link_label)
-		layout.addWidget(self.osf_link_field)
-		layout.addWidget(button_copy_to_clipboard)
-		layout.addWidget(button_open_in_browser)
-		return wdgt
-
 	def __resizeImagePreview(self, event):
 		""" Resize the image preview (if there is any) after a resize event """
 		if not self.current_img_preview is None:
@@ -537,22 +512,26 @@ def __create_properties_pane(self):
 		labelStyle = 'font-weight: bold'
 
 		self.common_fields = ['Name','Type']
-		self.file_fields = ['Size','Created','Modified']
+		self.file_fields = ['Size','Created','Modified','Link']
 
 		self.properties = {}
 		for field in self.common_fields + self.file_fields:
 			label = QtWidgets.QLabel(_(field))
 			label.setStyleSheet(labelStyle)
-			value = QElidedLabel('')
-			value.setWindowFlags(QtCore.Qt.Dialog)
+			if field == "Link":
+				# Initialize label with some HTML to trigger the rich text mode
+				value = QtWidgets.QLabel('<a></a>')
+				value.setOpenExternalLinks(True)
+			else:
+				value = QElidedLabel('')
+				value.setWindowFlags(QtCore.Qt.Dialog)
 			self.properties[field] = (label,value)
 			properties_pane.addRow(label,value)
 
 		# Make sure the fields specific for files are shown
 		for row in self.file_fields:
 			for field in self.properties[row]:
 				field.hide()
-
 		return properties_pane
 
 	### Public functions
@@ -735,6 +714,37 @@ def set_file_properties(self, data):
 			for field in self.properties[row]:
 				field.show()
 
+		# Get the link to the file on the website of OSF. This is not readily
+		# available from the returned API data, but can be parsed from the
+		# comments URL, of which it is the [target] filter parameter
+		# Sadly, this is URL is not always available for all files, so hide the
+		# row if parsing fails.
+		try:
+			comments_url = data["relationships"]["comments"]["links"]["related"]\
+				["href"]
+		except KeyError as e:
+			warnings.warn('Could not retrieve comments url, because of missing field {}'.format(e))
+			self.properties["Link"][0].hide()
+			self.properties["Link"][1].hide()
+		else:
+			# Use regular expression to search for the relevant part of the url
+			try:
+				target = re.search('filter\[target\]\=\w+', comments_url).group(0)
+			except AttributeError:
+				# If this didn't work, hide the row altogether
+				self.properties["Link"][0].hide()
+				self.properties["Link"][1].hide()
+			else:
+				# Get the ID part of the filter parameter and generate the url
+				web_id = target.split("=")[1]
+				web_url = u"https://osf.io/{}".format(web_id)
+				a = u"<a href=\"{0}\">{0}</a>".format(web_url)
+				# Set the URL in the field
+				self.properties["Link"][1].setText(a)
+				# Show the row
+				self.properties["Link"][0].show()
+				self.properties["Link"][1].show()
+
 	def set_folder_properties(self, data):
 		"""
 		Fills the contents of the properties pane for folders. Make sure the
@@ -851,13 +861,11 @@ def __slot_currentItemChanged(self, item, col):
 			self.upload_button.setDisabled(True)
 			self.delete_button.setDisabled(False)
 			self.new_folder_button.setDisabled(True)
-			self.link_widget.show()
 		elif kind == "folder":
 			self.set_folder_properties(data)
 			self.new_folder_button.setDisabled(False)
 			self.download_button.setDisabled(True)
 			self.upload_button.setDisabled(False)
-			self.link_widget.hide()
 			# Check if the parent node is a project
 			# If so the current 'folder' must be a storage provider (e.g. dropbox)
 			# which should not be allowed to be deleted.