ui_translate/update_ui.py

   1 # SPDX-License-Identifier: GPL-2.0-or-later
   2
   3 import os
   4
   5 if "bpy" in locals():
   6     import importlib
   7     importlib.reload(settings)
   8     importlib.reload(utils_i18n)
   9 else:
  10     import bpy
  11     from bpy.types import (
  12         Operator,
  13         Panel,
  14         PropertyGroup,
  15         UIList,
  16     )
  17     from bpy.props import (
  18         BoolProperty,
  19         IntProperty,
  20         StringProperty,
  21         CollectionProperty,
  22     )
  23     from . import settings
  24     from bl_i18n_utils import utils as utils_i18n
  25
  26 from bpy.app.translations import pgettext_iface as iface_
  27
  28
  29 # Data ########################################################################
  30
  31 class I18nUpdateTranslationLanguage(PropertyGroup):
  32     """Settings/info about a language"""
  33
  34     uid: StringProperty(
  35         name="Language ID",
  36         description="ISO code (eg. \"fr_FR\")",
  37         default="",
  38     )
  39
  40     num_id: IntProperty(
  41         name="Numeric ID",
  42         description="Numeric ID (read only!)",
  43         default=0, min=0,
  44     )
  45
  46     name: StringProperty(
  47         name="Language Name",
  48         description="Language label (eg. \"French (Français)\")",
  49         default="",
  50     )
  51
  52     use: BoolProperty(
  53         name="Use",
  54         description="If this language should be used in the current operator",
  55         default=True,
  56     )
  57
  58     po_path: StringProperty(
  59         name="PO File Path",
  60         description="Path to the relevant po file in branches",
  61         subtype='FILE_PATH',
  62         default="",
  63     )
  64
  65     po_path_trunk: StringProperty(
  66         name="PO Trunk File Path",
  67         description="Path to the relevant po file in trunk",
  68         subtype='FILE_PATH',
  69         default="",
  70     )
  71
  72     mo_path_trunk: StringProperty(
  73         name="MO File Path",
  74         description="Path to the relevant mo file",
  75         subtype='FILE_PATH',
  76         default="",
  77     )
  78
  79     po_path_git: StringProperty(
  80         name="PO Git Master File Path",
  81         description="Path to the relevant po file in Blender's translations git repository",
  82         subtype='FILE_PATH',
  83         default="",
  84     )
  85
  86
  87 class I18nUpdateTranslationSettings(PropertyGroup):
  88     """Settings/info about a language"""
  89
  90     langs: CollectionProperty(
  91         name="Languages",
  92         type=I18nUpdateTranslationLanguage,
  93         description="Languages to update in branches",
  94     )
  95
  96     active_lang: IntProperty(
  97         name="Active Language",
  98         default=0,
  99         description="Index of active language in langs collection",
 100     )
 101
 102     pot_path: StringProperty(
 103         name="POT File Path",
 104         description="Path to the pot template file",
 105         subtype='FILE_PATH',
 106         default="",
 107     )
 108
 109     is_init: BoolProperty(
 110         description="Whether these settings have already been auto-set or not",
 111         default=False,
 112         options={'HIDDEN'},
 113     )
 114
 115
 116 # UI ##########################################################################
 117
 118 class UI_UL_i18n_languages(UIList):
 119     """ """
 120
 121     def draw_item(self, context, layout, data, item, icon, active_data, active_propname, index):
 122         if self.layout_type in {'DEFAULT', 'COMPACT'}:
 123             layout.label(text=item.name, icon_value=icon)
 124             layout.prop(item, "use", text="")
 125         elif self.layout_type in {'GRID'}:
 126             layout.alignment = 'CENTER'
 127             layout.label(text=item.uid)
 128             layout.prop(item, "use", text="")
 129
 130
 131 class UI_PT_i18n_update_translations_settings(Panel):
 132     """ """
 133
 134     bl_label = "I18n Update Translation"
 135     bl_space_type = "PROPERTIES"
 136     bl_region_type = "WINDOW"
 137     bl_context = "render"
 138
 139     def draw(self, context):
 140         layout = self.layout
 141         i18n_sett = context.window_manager.i18n_update_svn_settings
 142
 143         if not i18n_sett.is_init and bpy.ops.ui.i18n_updatetranslation_svn_init_settings.poll():
 144             # Cannot call the operator from here, this code might run while `pyrna_write_check()` returns False
 145             # (which prevents any operator call from Python), during initialization of Blender.
 146             UI_OT_i18n_updatetranslation_svn_init_settings.execute_static(context, settings.settings)
 147
 148         if not i18n_sett.is_init:
 149             layout.label(text="Could not init languages data!")
 150             layout.label(text="Please edit the preferences of the UI Translate add-on")
 151             layout.operator("ui.i18n_updatetranslation_svn_init_settings", text="Init Settings")
 152         else:
 153             split = layout.split(factor=0.75)
 154             split.template_list("UI_UL_i18n_languages", "", i18n_sett, "langs", i18n_sett, "active_lang", rows=8)
 155             col = split.column()
 156             col.operator("ui.i18n_updatetranslation_svn_init_settings", text="Reset Settings")
 157             deselect = any(l.use for l in i18n_sett.langs)
 158             op = col.operator("ui.i18n_updatetranslation_svn_settings_select",
 159                               text="Deselect All" if deselect else "Select All")
 160             op.use_invert = False
 161             op.use_select = not deselect
 162             col.operator("ui.i18n_updatetranslation_svn_settings_select", text="Invert Selection").use_invert = True
 163             col.separator()
 164             col.operator("ui.i18n_updatetranslation_svn_branches", text="Update Branches")
 165             col.operator("ui.i18n_updatetranslation_svn_trunk", text="Update Trunk")
 166             col.separator()
 167             col.operator("ui.i18n_cleanuptranslation_svn_branches", text="Clean up Branches")
 168             col.operator("ui.i18n_updatetranslation_svn_statistics", text="Statistics")
 169
 170             if i18n_sett.active_lang >= 0 and i18n_sett.active_lang < len(i18n_sett.langs):
 171                 lng = i18n_sett.langs[i18n_sett.active_lang]
 172                 col = layout.column()
 173                 col.active = lng.use
 174                 row = col.row()
 175                 row.label(text="[{}]: \"{}\" ({})".format(lng.uid, iface_(lng.name), lng.num_id), translate=False)
 176                 row.prop(lng, "use", text="")
 177                 col.prop(lng, "po_path")
 178                 col.prop(lng, "po_path_trunk")
 179                 col.prop(lng, "mo_path_trunk")
 180                 col.prop(lng, "po_path_git")
 181             layout.separator()
 182             layout.prop(i18n_sett, "pot_path")
 183
 184             layout.separator()
 185             layout.label(text="Add-ons:")
 186             row = layout.row()
 187             op = row.operator("ui.i18n_addon_translation_invoke", text="Refresh I18n Data...")
 188             op.op_id = "ui.i18n_addon_translation_update"
 189             op = row.operator("ui.i18n_addon_translation_invoke", text="Export PO...")
 190             op.op_id = "ui.i18n_addon_translation_export"
 191             op = row.operator("ui.i18n_addon_translation_invoke", text="Import PO...")
 192             op.op_id = "ui.i18n_addon_translation_import"
 193
 194
 195 # Operators ###################################################################
 196
 197 class UI_OT_i18n_updatetranslation_svn_init_settings(Operator):
 198     """Init settings for i18n svn's update operators"""
 199
 200     bl_idname = "ui.i18n_updatetranslation_svn_init_settings"
 201     bl_label = "Init I18n Update Settings"
 202     bl_option = {'REGISTER'}
 203
 204     @classmethod
 205     def poll(cls, context):
 206         return context.window_manager is not None
 207
 208     @staticmethod
 209     def execute_static(context, self_settings):
 210         i18n_sett = context.window_manager.i18n_update_svn_settings
 211
 212         # First, create the list of languages from settings.
 213         i18n_sett.langs.clear()
 214         root_br = self_settings.BRANCHES_DIR
 215         root_tr_po = self_settings.TRUNK_PO_DIR
 216         root_git_po = self_settings.GIT_I18N_PO_DIR
 217         root_tr_mo = os.path.join(self_settings.TRUNK_DIR, self_settings.MO_PATH_TEMPLATE, self_settings.MO_FILE_NAME)
 218         if not (os.path.isdir(root_br) and os.path.isdir(root_tr_po)):
 219             i18n_sett.is_init = False
 220             return;
 221         for can_use, uid, num_id, name, isocode, po_path_branch in utils_i18n.list_po_dir(root_br, self_settings):
 222             lng = i18n_sett.langs.add()
 223             lng.use = can_use
 224             lng.uid = uid
 225             lng.num_id = num_id
 226             lng.name = name
 227             if can_use:
 228                 lng.po_path = po_path_branch
 229                 lng.po_path_trunk = os.path.join(root_tr_po, isocode + ".po")
 230                 lng.mo_path_trunk = root_tr_mo.format(isocode)
 231                 lng.po_path_git = os.path.join(root_git_po, isocode + ".po")
 232
 233         i18n_sett.pot_path = self_settings.FILE_NAME_POT
 234         i18n_sett.is_init = True
 235
 236     def execute(self, context):
 237         if not hasattr(self, "settings"):
 238             self.settings = settings.settings
 239
 240         self.execute_static(context, self.settings)
 241
 242         if context.window_manager.i18n_update_svn_settings.is_init is False:
 243             return {'CANCELLED'}
 244         return {'FINISHED'}
 245
 246
 247 class UI_OT_i18n_updatetranslation_svn_settings_select(Operator):
 248     """(De)select (or invert selection of) all languages for i18n svn's update operators"""
 249
 250     bl_idname = "ui.i18n_updatetranslation_svn_settings_select"
 251     bl_label = "Init I18n Update Select Languages"
 252
 253     # Operator Arguments
 254     use_select: BoolProperty(
 255         name="Select All",
 256         description="Select all if True, else deselect all",
 257         default=True,
 258     )
 259
 260     use_invert: BoolProperty(
 261         name="Invert Selection",
 262         description="Inverse selection (overrides 'Select All' when True)",
 263         default=False,
 264     )
 265     # /End Operator Arguments
 266
 267     @classmethod
 268     def poll(cls, context):
 269         return context.window_manager is not None
 270
 271     def execute(self, context):
 272         if self.use_invert:
 273             for lng in context.window_manager.i18n_update_svn_settings.langs:
 274                 lng.use = not lng.use
 275         else:
 276             for lng in context.window_manager.i18n_update_svn_settings.langs:
 277                 lng.use = self.use_select
 278         return {'FINISHED'}
 279
 280
 281 classes = (
 282     I18nUpdateTranslationLanguage,
 283     I18nUpdateTranslationSettings,
 284     UI_UL_i18n_languages,
 285     UI_PT_i18n_update_translations_settings,
 286     UI_OT_i18n_updatetranslation_svn_init_settings,
 287     UI_OT_i18n_updatetranslation_svn_settings_select,
 288 )