kindred/create
1
1
Fork 0
Code Issues 37 Pull Requests Actions Packages Projects 9 Releases 2 Wiki Activity

Addon Manager: Refactor Licenses and People tables

Browse Source
This commit is contained in:
Chris Hennes
2022-09-08 17:55:22 -05:00
parent 9348486a1f
commit b3dd3b6d00
16 changed files with 1071 additions and 834 deletions
Download Patch File Download Diff File Expand all files Collapse all files

406
src/Mod/AddonManager/addonmanager_devmode.py
View File

@@ -23,11 +23,18 @@
""" Classes to manage "Developer Mode" """
import os
import datetime
import FreeCAD
import FreeCADGui
from PySide2.QtWidgets import QFileDialog, QTableWidgetItem, QListWidgetItem, QDialog
from PySide2.QtWidgets import (
QFileDialog,
QTableWidgetItem,
QListWidgetItem,
QDialog,
QSizePolicy,
)
from PySide2.QtGui import (
QIcon,
QPixmap,
@@ -35,10 +42,11 @@ from PySide2.QtGui import (
from PySide2.QtCore import Qt
from addonmanager_git import GitManager
from addonmanager_devmode_license_selector import LicenseSelector
from addonmanager_devmode_person_editor import PersonEditor
from addonmanager_devmode_add_content import AddContent
from addonmanager_devmode_validators import NameValidator, VersionValidator
from addonmanager_devmode_predictor import Predictor
from addonmanager_devmode_people_table import PeopleTable
from addonmanager_devmode_licenses_table import LicensesTable
translate = FreeCAD.Qt.translate
@@ -47,6 +55,7 @@ translate = FreeCAD.Qt.translate
ContentTypeRole = Qt.UserRole
ContentIndexRole = Qt.UserRole + 1
class AddonGitInterface:
"""Wrapper to handle the git calls needed by this class"""
@@ -82,7 +91,6 @@ class AddonGitInterface:
return []
class DeveloperMode:
"""The main Developer Mode dialog, for editing package.xml metadata graphically."""
@@ -97,6 +105,20 @@ class DeveloperMode:
self.dialog = FreeCADGui.PySideUic.loadUi(
os.path.join(os.path.dirname(__file__), "developer_mode.ui")
)
self.people_table = PeopleTable()
self.licenses_table = LicensesTable()
large_size_policy = QSizePolicy(QSizePolicy.Expanding, QSizePolicy.Expanding)
large_size_policy.setHorizontalStretch(2)
small_size_policy = QSizePolicy(QSizePolicy.Expanding, QSizePolicy.Expanding)
small_size_policy.setHorizontalStretch(1)
self.people_table.widget.setSizePolicy(large_size_policy)
self.licenses_table.widget.setSizePolicy(small_size_policy)
self.dialog.peopleAndLicenseshorizontalLayout.addWidget(
self.people_table.widget
)
self.dialog.peopleAndLicenseshorizontalLayout.addWidget(
self.licenses_table.widget
)
self.pref = FreeCAD.ParamGet("User parameter:BaseApp/Preferences/Addons")
self.current_mod: str = ""
self.git_interface = None
@@ -108,18 +130,6 @@ class DeveloperMode:
self.dialog.displayNameLineEdit.setValidator(NameValidator())
self.dialog.versionLineEdit.setValidator(VersionValidator())
self.dialog.addPersonToolButton.setIcon(
QIcon.fromTheme("add", QIcon(":/icons/list-add.svg"))
)
self.dialog.removePersonToolButton.setIcon(
QIcon.fromTheme("remove", QIcon(":/icons/list-remove.svg"))
)
self.dialog.addLicenseToolButton.setIcon(
QIcon.fromTheme("add", QIcon(":/icons/list-add.svg"))
)
self.dialog.removeLicenseToolButton.setIcon(
QIcon.fromTheme("remove", QIcon(":/icons/list-remove.svg"))
)
self.dialog.addContentItemToolButton.setIcon(
QIcon.fromTheme("add", QIcon(":/icons/list-add.svg"))
)
@@ -127,21 +137,34 @@ class DeveloperMode:
QIcon.fromTheme("remove", QIcon(":/icons/list-remove.svg"))
)
def show(self, parent=None):
def show(self, parent=None, path=None):
"""Show the main dev mode dialog"""
if parent:
self.dialog.setParent(parent)
if path and os.path.exists(path):
self.dialog.pathToAddonComboBox.setEditText(path)
elif self.pref.HasGroup("recentModsList"):
recent_mods_group = self.pref.GetGroup("recentModsList")
entry = recent_mods_group.GetString("Mod0", "")
if entry:
self._populate_dialog(entry)
self._update_recent_mods(entry)
self._populate_combo()
else:
self._clear_all_fields()
else:
self._clear_all_fields()
result = self.dialog.exec()
if result == QDialog.Accepted:
self._sync_metadata_to_ui()
self.metadata.write(os.path.join(self.current_mod, "package.xml"))
def _populate_dialog(self, path_to_repo):
"""Populate this dialog using the best available parsing of the contents of the repo at
path_to_repo. This is a multi-layered process that starts with any existing package.xml
file or other known metadata files, and proceeds through examining the contents of the
directory structure."""
if self.current_mod == path_to_repo:
return
self.current_mod = path_to_repo
self._scan_for_git_info(self.current_mod)
@@ -178,78 +201,13 @@ class DeveloperMode:
self.dialog.descriptionTextEdit.setPlainText(self.metadata.Description)
self.dialog.versionLineEdit.setText(self.metadata.Version)
self._populate_people_from_metadata(self.metadata)
self._populate_licenses_from_metadata(self.metadata)
self._populate_urls_from_metadata(self.metadata)
self._populate_contents_from_metadata(self.metadata)
self._populate_icon_from_metadata(self.metadata)
def _populate_people_from_metadata(self, metadata):
"""Use the passed metadata object to populate the maintainers and authors"""
self.dialog.peopleTableWidget.setRowCount(0)
row = 0
for maintainer in metadata.Maintainer:
name = maintainer["name"]
email = maintainer["email"]
self._add_person_row(row, "maintainer", name, email)
row += 1
for author in metadata.Author:
name = author["name"]
email = author["email"]
self._add_person_row(row, "author", name, email)
row += 1
if row == 0:
FreeCAD.Console.PrintWarning(
translate(
"AddonsInstaller",
"WARNING: No maintainer data found in metadata file.",
)
+ "\n"
)
def _add_person_row(self, row, person_type, name, email):
"""Add this person to the peopleTableWidget at row given"""
self.dialog.peopleTableWidget.insertRow(row)
item = QTableWidgetItem(self.person_type_translation[person_type])
item.setData(Qt.UserRole, person_type)
self.dialog.peopleTableWidget.setItem(row, 0, item)
self.dialog.peopleTableWidget.setItem(row, 1, QTableWidgetItem(name))
self.dialog.peopleTableWidget.setItem(row, 2, QTableWidgetItem(email))
def _populate_licenses_from_metadata(self, metadata):
"""Use the passed metadata object to populate the licenses"""
self.dialog.licensesTableWidget.setRowCount(0)
row = 0
for lic in metadata.License:
name = lic["name"]
path = lic["file"]
self._add_license_row(row, name, path)
row += 1
if row == 0:
FreeCAD.Console.PrintWarning(
translate(
"AddonsInstaller",
"WARNING: No license data found in metadata file",
)
+ "\n"
)
def _add_license_row(self, row: int, name: str, path: str):
""" Add a row to the table of licenses """
self.dialog.licensesTableWidget.insertRow(row)
self.dialog.licensesTableWidget.setItem(row, 0, QTableWidgetItem(name))
self.dialog.licensesTableWidget.setItem(row, 1, QTableWidgetItem(path))
full_path = os.path.join(self.current_mod, path)
if not os.path.isfile(full_path):
FreeCAD.Console.PrintError(
translate(
"AddonsInstaller",
"ERROR: Could not locate license file at {}",
).format(full_path)
+ "\n"
)
self.people_table.show(self.metadata)
self.licenses_table.show(self.metadata, self.current_mod)
def _populate_urls_from_metadata(self, metadata):
"""Use the passed metadata object to populate the urls"""
@@ -312,7 +270,7 @@ class DeveloperMode:
)
contents_string += ", ".join(info)
item = QListWidgetItem (contents_string)
item = QListWidgetItem(contents_string)
item.setData(ContentTypeRole, content_type)
item.setData(ContentIndexRole, counter)
self.dialog.contentsListWidget.addItem(item)
@@ -329,7 +287,7 @@ class DeveloperMode:
else:
self.has_toplevel_icon = False
contents = metadata.Content
if contents["workbench"]:
if "workbench" in contents:
for wb in contents["workbench"]:
icon = wb.Icon
path = wb.Subdirectory
@@ -339,7 +297,7 @@ class DeveloperMode:
)
break
if os.path.isfile(icon_path):
if icon_path and os.path.isfile(icon_path):
icon_data = QIcon(icon_path)
if not icon_data.isNull():
self.dialog.iconDisplayLabel.setPixmap(icon_data.pixmap(32, 32))
@@ -348,13 +306,8 @@ class DeveloperMode:
def _predict_metadata(self):
"""If there is no metadata, try to guess at values for it"""
self.metadata = FreeCAD.Metadata()
self._predict_author_info()
self._predict_name()
self._predict_description()
self._predict_contents()
self._predict_icon()
self._predict_urls()
self._predict_license()
predictor = Predictor()
self.metadata = predictor.predict_metadata(self.current_mod)
def _scan_for_git_info(self, path):
"""Look for branch availability"""
@@ -378,59 +331,6 @@ class DeveloperMode:
self.dialog.documentationURLLineEdit.clear()
self.dialog.iconDisplayLabel.setPixmap(QPixmap())
self.dialog.iconPathLineEdit.clear()
self.dialog.licensesTableWidget.setRowCount(0)
self.dialog.peopleTableWidget.setRowCount(0)
def _predict_author_info(self):
""" Look at the git commit history and attempt to discern maintainer and author
information."""
self.git_interface = AddonGitInterface(path)
if self.git_interface.git_exists:
committers = self.git_interface.get_last_committers()
else:
return
# This is a dictionary keyed to the author's name (which can be many different
# things, depending on the author) containing two fields, "email" and "count". It
# is common for there to be multiple entries representing the same human being,
# so a passing attempt is made to reconcile:
for key in committers:
emails = committers[key]["email"]
if "GitHub" in key:
# Robotic merge commit (or other similar), ignore
continue
# Does any other committer share any of these emails?
for other_key in committers:
if other_key == key:
continue
other_emails = committers[other_key]["email"]
for other_email in other_emails:
if other_email in emails:
# There is overlap in the two email lists, so this is probably the
# same author, with a different name (username, pseudonym, etc.)
if not committers[key]["aka"]:
committers[key]["aka"] = set()
committers[key]["aka"].add(other_key)
committers[key]["count"] += committers[other_key]["count"]
committers[key]["email"].combine(committers[other_key]["email"])
committers.remove(other_key)
break
maintainers = []
for name,info in committers.items():
if info["aka"]:
for other_name in info["aka"]:
# Heuristic: the longer name is more likely to be the actual legal name
if len(other_name) > len(name):
name = other_name
# There is no logical basis to choose one email address over another, so just
# take the first one
email = info["email"][0]
commit_count = info["count"]
maintainers.append( {"name":name,"email":email,"count":commit_count} )
# Sort by count of commits
maintainers.sort(lambda i:i["count"],reverse=True)
def _setup_dialog_signals(self):
"""Set up the signal and slot connections for the main dialog."""
@@ -442,75 +342,71 @@ class DeveloperMode:
self._addon_combo_text_changed
)
self.dialog.addLicenseToolButton.clicked.connect(self._add_license_clicked)
self.dialog.removeLicenseToolButton.clicked.connect(
self._remove_license_clicked
)
self.dialog.licensesTableWidget.itemSelectionChanged.connect(
self._license_selection_changed
)
self.dialog.licensesTableWidget.itemDoubleClicked.connect(self._edit_license)
self.dialog.addPersonToolButton.clicked.connect(self._add_person_clicked)
self.dialog.removePersonToolButton.clicked.connect(self._remove_person_clicked)
self.dialog.peopleTableWidget.itemSelectionChanged.connect(
self._person_selection_changed
)
self.dialog.peopleTableWidget.itemDoubleClicked.connect(self._edit_person)
self.dialog.addContentItemToolButton.clicked.connect(self._add_content_clicked)
self.dialog.removeContentItemToolButton.clicked.connect(self._remove_content_clicked)
self.dialog.contentsListWidget.itemSelectionChanged.connect(self._content_selection_changed)
self.dialog.removeContentItemToolButton.clicked.connect(
self._remove_content_clicked
)
self.dialog.contentsListWidget.itemSelectionChanged.connect(
self._content_selection_changed
)
self.dialog.contentsListWidget.itemDoubleClicked.connect(self._edit_content)
self.dialog.versionToTodayButton.clicked.connect(self._set_to_today_clicked)
# Finally, populate the combo boxes, etc.
self._populate_combo()
if self.dialog.pathToAddonComboBox.currentIndex() != -1:
self._populate_dialog(self.dialog.pathToAddonComboBox.currentText())
# Disable all of the "Remove" buttons until something is selected
self.dialog.removeLicenseToolButton.setDisabled(True)
self.dialog.removePersonToolButton.setDisabled(True)
self.dialog.removeContentItemToolButton.setDisabled(True)
def _sync_metadata_to_ui(self):
""" Take the data from the UI fields and put it into the stored metadata
object. Only overwrites known data fields: unknown metadata will be retained. """
"""Take the data from the UI fields and put it into the stored metadata
object. Only overwrites known data fields: unknown metadata will be retained."""
if not self.metadata:
self.metadata = FreeCAD.Metadata()
self.metadata.Name = self.dialog.displayNameLineEdit.text()
self.metadata.Description = self.descriptionTextEdit.text()
self.metadata.Description = (
self.dialog.descriptionTextEdit.document().toPlainText()
)
self.metadata.Version = self.dialog.versionLineEdit.text()
self.metadata.Icon = self.dialog.iconPathLineEdit.text()
url = {}
url["website"] = self.dialog.websiteURLLineEdit.text()
url["repository"] = self.dialog.repositoryURLLineEdit.text()
url["bugtracker"] = self.dialog.bugtrackerURLLineEdit.text()
url["readme"] = self.dialog.readmeURLLineEdit.text()
url["documentation"] = self.dialog.documentationURLLineEdit.text()
self.metadata.setUrl(url)
# Licenses:
licenses = []
for row in range(self.dialog.licensesTableWidget.rowCount()):
license = {}
license["name"] = self.dialog.licensesTableWidget.item(row,0).text()
license["file"] = self.dialog.licensesTableWidget.item(row,1).text()
licenses.append(license)
self.metadata.setLicense(licenses)
urls = []
if self.dialog.websiteURLLineEdit.text():
urls.append(
{"location": self.dialog.websiteURLLineEdit.text(), "type": "website"}
)
if self.dialog.repositoryURLLineEdit.text():
urls.append(
{
"location": self.dialog.repositoryURLLineEdit.text(),
"type": "repository",
"branch": self.dialog.branchComboBox.currentText(),
}
)
if self.dialog.bugtrackerURLLineEdit.text():
urls.append(
{
"location": self.dialog.bugtrackerURLLineEdit.text(),
"type": "bugtracker",
}
)
if self.dialog.readmeURLLineEdit.text():
urls.append(
{"location": self.dialog.readmeURLLineEdit.text(), "type": "readme"}
)
if self.dialog.documentationURLLineEdit.text():
urls.append(
{
"location": self.dialog.documentationURLLineEdit.text(),
"type": "documentation",
}
)
self.metadata.Urls = urls
# Maintainers:
maintainers = []
authors = []
for row in range(self.dialog.peopleTableWidget.rowCount()):
person = {}
person["name"] = self.dialog.peopleTableWidget.item(row,1).text()
person["email"] = self.dialog.peopleTableWidget.item(row,2).text()
if self.dialog.peopleTableWidget.item(row,0).data(Qt.UserRole) == "maintainer":
maintainers.append(person)
elif self.dialog.peopleTableWidget.item(row,0).data(Qt.UserRole) == "author":
authors.append(person)
# Content:
# Content, people, and licenses should already be sync'ed
###############################################################################################
# DIALOG SLOTS
@@ -540,6 +436,8 @@ class DeveloperMode:
if new_text == self.current_mod:
# It doesn't look like it actually changed, bail out
return
self.metadata = None
self._clear_all_fields()
if not os.path.exists(new_text):
# This isn't a thing (Yet. Maybe the user is still typing?)
return
@@ -588,108 +486,34 @@ class DeveloperMode:
entry_name = f"Mod{i}"
recent_mods_group.SetString(entry_name, mod)
def _person_selection_changed(self):
""" Callback: the current selection in the peopleTableWidget changed """
items = self.dialog.peopleTableWidget.selectedItems()
if items:
self.dialog.removePersonToolButton.setDisabled(False)
else:
self.dialog.removePersonToolButton.setDisabled(True)
def _license_selection_changed(self):
""" Callback: the current selection in the licensesTableWidget changed """
items = self.dialog.licensesTableWidget.selectedItems()
if items:
self.dialog.removeLicenseToolButton.setDisabled(False)
else:
self.dialog.removeLicenseToolButton.setDisabled(True)
def _add_license_clicked(self):
""" Callback: The Add License button was clicked """
license_selector = LicenseSelector(self.current_mod)
short_code, path = license_selector.exec()
if short_code:
self._add_license_row(
self.dialog.licensesTableWidget.rowCount(), short_code, path
)
def _remove_license_clicked(self):
""" Callback: the Remove License button was clicked """
items = self.dialog.licensesTableWidget.selectedIndexes()
if items:
# We only support single-selection, so can just pull the row # from
# the first entry
self.dialog.licensesTableWidget.removeRow(items[0].row())
def _edit_license(self, item):
""" Callback: a license row was double-clicked """
row = item.row()
short_code = self.dialog.licensesTableWidget.item(row, 0).text()
path = self.dialog.licensesTableWidget.item(row, 1).text()
license_selector = LicenseSelector(self.current_mod)
short_code, path = license_selector.exec(short_code, path)
if short_code:
self.dialog.licensesTableWidget.removeRow(row)
self._add_license_row(row, short_code, path)
def _add_person_clicked(self):
""" Callback: the Add Person button was clicked """
dlg = PersonEditor()
person_type, name, email = dlg.exec()
if person_type and name:
self._add_person_row(row, person_type, name, email)
def _remove_person_clicked(self):
""" Callback: the Remove Person button was clicked """
items = self.dialog.peopleTableWidget.selectedIndexes()
if items:
# We only support single-selection, so can just pull the row # from
# the first entry
self.dialog.peopleTableWidget.removeRow(items[0].row())
def _edit_person(self, item):
""" Callback: a row in the peopleTableWidget was double-clicked """
row = item.row()
person_type = self.dialog.peopleTableWidget.item(row, 0).data(Qt.UserRole)
name = self.dialog.peopleTableWidget.item(row, 1).text()
email = self.dialog.peopleTableWidget.item(row, 2).text()
dlg = PersonEditor()
dlg.setup(person_type, name, email)
person_type, name, email = dlg.exec()
if person_type and name:
self.dialog.peopleTableWidget.removeRow(row)
self._add_person_row(row, person_type, name, email)
self.dialog.peopleTableWidget.selectRow(row)
def _add_content_clicked(self):
""" Callback: The Add Content button was clicked """
"""Callback: The Add Content button was clicked"""
dlg = AddContent(self.current_mod, self.metadata)
singleton = False
if self.dialog.contentsListWidget.count() == 0:
singleton = True
content_type,new_metadata = dlg.exec(singleton=singleton)
content_type, new_metadata = dlg.exec(singleton=singleton)
if content_type and new_metadata:
self.metadata.addContentItem(content_type, new_metadata)
self._populate_contents_from_metadata(self.metadata)
def _remove_content_clicked(self):
""" Callback: the remove content button was clicked """
"""Callback: the remove content button was clicked"""
item = self.dialog.contentsListWidget.currentItem()
if not item:
return
content_type = item.data(ContentTypeRole)
content_index = item.data(ContentIndexRole)
if self.metadata.Content[content_type] and content_index < len(self.metadata.Content[content_type]):
if self.metadata.Content[content_type] and content_index < len(
self.metadata.Content[content_type]
):
content_name = self.metadata.Content[content_type][content_index].Name
self.metadata.removeContentItem(content_type,content_name)
self.metadata.removeContentItem(content_type, content_name)
self._populate_contents_from_metadata(self.metadata)
def _content_selection_changed(self):
""" Callback: the selected content item changed """
"""Callback: the selected content item changed"""
items = self.dialog.contentsListWidget.selectedItems()
if items:
self.dialog.removeContentItemToolButton.setDisabled(False)
@@ -697,7 +521,7 @@ class DeveloperMode:
self.dialog.removeContentItemToolButton.setDisabled(True)
def _edit_content(self, item):
""" Callback: a content row was double-clicked """
"""Callback: a content row was double-clicked"""
dlg = AddContent(self.current_mod, self.metadata)
content_type = item.data(ContentTypeRole)
@@ -712,4 +536,10 @@ class DeveloperMode:
self.metadata.addContentItem(new_type, new_metadata)
self._populate_contents_from_metadata(self.metadata)
def _set_to_today_clicked(self):
"""Callback: the "set to today" button was clicked"""
year = datetime.date.today().year
month = datetime.date.today().month
day = datetime.date.today().day
version_string = f"{year}.{month:>02}.{day:>02}"
self.dialog.versionLineEdit.setText(version_string)