Skip to content

ayon_clockify

ClockifyAddon

Bases: AYONAddon, ITrayAddon, IPluginPaths

Source code in client/ayon_clockify/addon.py
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
class ClockifyAddon(AYONAddon, ITrayAddon, IPluginPaths):
    name = "clockify"
    version = __version__

    def initialize(self, studio_settings):
        enabled = self.name in studio_settings
        workspace_name = None
        if enabled:
            clockify_settings = studio_settings[self.name]
            workspace_name = clockify_settings["workspace_name"]

        if enabled and not workspace_name:
            self.log.warning("Clockify Workspace is not set in settings.")
            enabled = False
        self.enabled = enabled
        self.workspace_name = workspace_name

        self.timer_manager = None
        self.MessageWidgetClass = None
        self.message_widget = None
        self._clockify_api = None

        # TimersManager attributes
        # - set `timers_manager_connector` only in `tray_init`
        self.timers_manager_connector = None
        self._timer_manager_addon = None

    @property
    def clockify_api(self):
        if self._clockify_api is None:
            from .clockify_api import ClockifyAPI

            self._clockify_api = ClockifyAPI(master_parent=self)
        return self._clockify_api

    def get_global_environments(self):
        return {"CLOCKIFY_WORKSPACE": self.workspace_name}

    def tray_init(self):
        from .widgets import ClockifySettings, MessageWidget

        self.MessageWidgetClass = MessageWidget

        self.message_widget = None
        self.widget_settings = ClockifySettings(self.clockify_api)
        self.widget_settings_required = None

        self.thread_timer_check = None
        # Bools
        self.bool_thread_check_running = False
        self.bool_api_key_set = False
        self.bool_workspace_set = False
        self.bool_timer_run = False
        self.bool_api_key_set = self.clockify_api.set_api()

        # Define itself as TimersManager connector
        self.timers_manager_connector = self

    def tray_start(self):
        if self.bool_api_key_set is False:
            self.show_settings()
            return

        self.bool_workspace_set = self.clockify_api.workspace_id is not None
        if self.bool_workspace_set is False:
            return

        self.start_timer_check()
        self.set_menu_visibility()

    def tray_exit(self, *_a, **_kw):
        return

    def get_plugin_paths(self):
        """Implementation of IPluginPaths to get plugin paths."""
        actions_path = os.path.join(
            os.path.dirname(os.path.abspath(__file__)), "launcher_actions"
        )
        return {"actions": [actions_path]}

    def get_ftrack_event_handler_paths(self):
        """Function for ftrack addon to add ftrack event handler paths."""
        return {
            "user": [CLOCKIFY_FTRACK_USER_PATH],
            "server": [CLOCKIFY_FTRACK_SERVER_PATH],
        }

    def clockify_timer_stopped(self):
        self.bool_timer_run = False
        self.timer_stopped()

    def start_timer_check(self):
        self.bool_thread_check_running = True
        if self.thread_timer_check is None:
            self.thread_timer_check = threading.Thread(
                target=self.check_running
            )
            self.thread_timer_check.daemon = True
            self.thread_timer_check.start()

    def stop_timer_check(self):
        self.bool_thread_check_running = True
        if self.thread_timer_check is not None:
            self.thread_timer_check.join()
            self.thread_timer_check = None

    def check_running(self):
        while self.bool_thread_check_running is True:
            bool_timer_run = False
            if self.clockify_api.get_in_progress() is not None:
                bool_timer_run = True

            if self.bool_timer_run != bool_timer_run:
                if self.bool_timer_run is True:
                    self.clockify_timer_stopped()
                elif self.bool_timer_run is False:
                    current_timer = self.clockify_api.get_in_progress()
                    if current_timer is None:
                        continue
                    current_proj_id = current_timer.get("projectId")
                    if not current_proj_id:
                        continue

                    project = self.clockify_api.get_project_by_id(
                        current_proj_id
                    )
                    if project and project.get("code") == 501:
                        continue

                    project_name = project.get("name")

                    current_timer_hierarchy = current_timer.get("description")
                    if not current_timer_hierarchy:
                        continue
                    hierarchy_items = current_timer_hierarchy.split("/")
                    # Each pype timer must have at least 2 items!
                    if len(hierarchy_items) < 2:
                        continue

                    task_name = hierarchy_items[-1]
                    hierarchy = hierarchy_items[:-1]

                    data = {
                        "task_name": task_name,
                        "hierarchy": hierarchy,
                        "project_name": project_name,
                    }
                    self.timer_started(data)

                self.bool_timer_run = bool_timer_run
                self.set_menu_visibility()
            time.sleep(5)

    def signed_in(self):
        if not self.timer_manager:
            return

        if not self.timer_manager.last_task:
            return

        if self.timer_manager.is_running:
            self.start_timer_manager(self.timer_manager.last_task)

    def on_message_widget_close(self):
        self.message_widget = None

    # Definition of Tray menu
    def tray_menu(self, parent_menu):
        # Menu for Tray App
        from qtpy import QtWidgets

        menu = QtWidgets.QMenu("Clockify", parent_menu)
        menu.setProperty("submenu", "on")

        # Actions
        action_show_settings = QtWidgets.QAction("Settings", menu)
        action_stop_timer = QtWidgets.QAction("Stop timer", menu)

        menu.addAction(action_show_settings)
        menu.addAction(action_stop_timer)

        action_show_settings.triggered.connect(self.show_settings)
        action_stop_timer.triggered.connect(self.stop_timer)

        self.action_stop_timer = action_stop_timer

        self.set_menu_visibility()

        parent_menu.addMenu(menu)

    def show_settings(self):
        self.widget_settings.input_api_key.setText(
            self.clockify_api.get_api_key()
        )
        self.widget_settings.show()

    def set_menu_visibility(self):
        self.action_stop_timer.setVisible(self.bool_timer_run)

    # --- TimersManager connection methods ---
    def register_timers_manager(self, timer_manager_addon):
        """Store TimersManager for future use."""
        self._timer_manager_addon = timer_manager_addon

    def timer_started(self, data):
        """Tell TimersManager that timer started."""
        if self._timer_manager_addon is not None:
            self._timer_manager_addon.timer_started(self.id, data)

    def timer_stopped(self):
        """Tell TimersManager that timer stopped."""
        if self._timer_manager_addon is not None:
            self._timer_manager_addon.timer_stopped(self.id)

    def stop_timer(self):
        """Called from TimersManager to stop timer."""
        self.clockify_api.finish_time_entry()

    def _verify_project_exists(self, project_name):
        project_id = self.clockify_api.get_project_id(project_name)
        if not project_id:
            self.log.warning(
                'Project "{}" was not found in Clockify. Timer won\'t start.'
            ).format(project_name)

            if not self.MessageWidgetClass:
                return

            msg = (
                'Project <b>"{}"</b> is not'
                ' in Clockify Workspace <b>"{}"</b>.'
                "<br><br>Please inform your Project Manager."
            ).format(project_name, str(self.clockify_api.workspace_name))

            self.message_widget = self.MessageWidgetClass(
                msg, "Clockify - Info Message"
            )
            self.message_widget.closed.connect(self.on_message_widget_close)
            self.message_widget.show()
            return False
        return project_id

    def start_timer(self, input_data):
        """Called from TimersManager to start timer."""
        # If not api key is not entered then skip
        if not self.clockify_api.get_api_key():
            return

        project_name = input_data.get("project_name")
        folder_path = input_data.get("folder_path")
        task_name = input_data.get("task_name")
        task_type = input_data.get("task_type")
        if not all((project_name, folder_path, task_name, task_type)):
            return

        # Concatenate hierarchy and task to get description
        description = "/".join([folder_path.lstrip("/"), task_name])

        # Check project existence
        project_id = self._verify_project_exists(project_name)
        if not project_id:
            return

        # Setup timer tags
        if not task_type:
            self.log.info("No tag information found for the timer")

        tag_ids = []
        task_tag_id = self.clockify_api.get_tag_id(task_type)
        if task_tag_id is not None:
            tag_ids.append(task_tag_id)

        # Start timer
        self.clockify_api.start_time_entry(
            description,
            project_id,
            tag_ids=tag_ids,
            workspace_id=self.clockify_api.workspace_id,
            user_id=self.clockify_api.user_id,
        )

get_ftrack_event_handler_paths()

Function for ftrack addon to add ftrack event handler paths.

Source code in client/ayon_clockify/addon.py
91
92
93
94
95
96
def get_ftrack_event_handler_paths(self):
    """Function for ftrack addon to add ftrack event handler paths."""
    return {
        "user": [CLOCKIFY_FTRACK_USER_PATH],
        "server": [CLOCKIFY_FTRACK_SERVER_PATH],
    }

get_plugin_paths()

Implementation of IPluginPaths to get plugin paths.

Source code in client/ayon_clockify/addon.py
84
85
86
87
88
89
def get_plugin_paths(self):
    """Implementation of IPluginPaths to get plugin paths."""
    actions_path = os.path.join(
        os.path.dirname(os.path.abspath(__file__)), "launcher_actions"
    )
    return {"actions": [actions_path]}

register_timers_manager(timer_manager_addon)

Store TimersManager for future use.

Source code in client/ayon_clockify/addon.py
211
212
213
def register_timers_manager(self, timer_manager_addon):
    """Store TimersManager for future use."""
    self._timer_manager_addon = timer_manager_addon

start_timer(input_data)

Called from TimersManager to start timer.

Source code in client/ayon_clockify/addon.py
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
def start_timer(self, input_data):
    """Called from TimersManager to start timer."""
    # If not api key is not entered then skip
    if not self.clockify_api.get_api_key():
        return

    project_name = input_data.get("project_name")
    folder_path = input_data.get("folder_path")
    task_name = input_data.get("task_name")
    task_type = input_data.get("task_type")
    if not all((project_name, folder_path, task_name, task_type)):
        return

    # Concatenate hierarchy and task to get description
    description = "/".join([folder_path.lstrip("/"), task_name])

    # Check project existence
    project_id = self._verify_project_exists(project_name)
    if not project_id:
        return

    # Setup timer tags
    if not task_type:
        self.log.info("No tag information found for the timer")

    tag_ids = []
    task_tag_id = self.clockify_api.get_tag_id(task_type)
    if task_tag_id is not None:
        tag_ids.append(task_tag_id)

    # Start timer
    self.clockify_api.start_time_entry(
        description,
        project_id,
        tag_ids=tag_ids,
        workspace_id=self.clockify_api.workspace_id,
        user_id=self.clockify_api.user_id,
    )

stop_timer()

Called from TimersManager to stop timer.

Source code in client/ayon_clockify/addon.py
225
226
227
def stop_timer(self):
    """Called from TimersManager to stop timer."""
    self.clockify_api.finish_time_entry()

timer_started(data)

Tell TimersManager that timer started.

Source code in client/ayon_clockify/addon.py
215
216
217
218
def timer_started(self, data):
    """Tell TimersManager that timer started."""
    if self._timer_manager_addon is not None:
        self._timer_manager_addon.timer_started(self.id, data)

timer_stopped()

Tell TimersManager that timer stopped.

Source code in client/ayon_clockify/addon.py
220
221
222
223
def timer_stopped(self):
    """Tell TimersManager that timer stopped."""
    if self._timer_manager_addon is not None:
        self._timer_manager_addon.timer_stopped(self.id)