1
2
3
4
5
6
7
8
9
10
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
|
# Authors: see git history
#
# Copyright (c) 2024 Authors
# Licensed under the GNU GPL version 3.0 or later. See the file LICENSE for details.
from inkex import errormsg
from .commands import ensure_symbol
from .elements import EmbroideryElement
from .gui.request_update_svg_version import RequestUpdate
from .i18n import _
from .metadata import InkStitchMetadata
from .svg import PIXELS_PER_MM
from .svg.tags import EMBROIDERABLE_TAGS, INKSTITCH_ATTRIBS
INKSTITCH_SVG_VERSION = 3
def update_inkstitch_document(svg, selection=None):
document = svg.getroot()
# get the inkstitch svg version from the document
search_string = "//*[local-name()='inkstitch_svg_version']//text()"
file_version = document.findone(search_string)
try:
file_version = int(file_version)
except (TypeError, ValueError):
file_version = 0
if file_version == INKSTITCH_SVG_VERSION:
return
if file_version > INKSTITCH_SVG_VERSION:
errormsg(_("This document was created with a newer Version of Ink/Stitch. "
"It is possible that not everything works as expected.\n\n"
"Please update your Ink/Stitch version: https://inkstitch.org/docs/install/"))
# they may not want to be bothered with this info everytime they call an inkstitch extension
# let's udowngrade the file version number
_update_inkstitch_svg_version(svg)
else:
# this document is either a new document or it is outdated
# if we cannot find any inkstitch attribute in the document, we assume that this is a new document which doesn't need to be updated
search_string = "//*[namespace-uri()='http://inkstitch.org/namespace' or " \
"@*[namespace-uri()='http://inkstitch.org/namespace'] or " \
"@*[starts-with(name(), 'embroider_')]]"
inkstitch_element = document.findone(search_string)
if inkstitch_element is None:
_update_inkstitch_svg_version(svg)
return
# update elements
if selection:
# this comes from the updater extension where we only update selected elements
for element in selection:
update_legacy_params(EmbroideryElement(element), file_version, INKSTITCH_SVG_VERSION)
else:
# this is the automatic update when a legacy inkstitch svg version was recognized
automatic_version_update(document, file_version, INKSTITCH_SVG_VERSION)
_update_inkstitch_svg_version(svg)
def automatic_version_update(document, file_version, INKSTITCH_SVG_VERSION):
# make sure the user really wants to update
if file_version == 0:
do_update = RequestUpdate()
if do_update.cancelled is True:
return
# well then, let's update legeacy params
for element in document.iterdescendants():
if element.tag in EMBROIDERABLE_TAGS:
update_legacy_params(EmbroideryElement(element), file_version, INKSTITCH_SVG_VERSION)
if file_version < 3:
update_legacy_commands(document)
def _update_inkstitch_svg_version(svg):
# set inkstitch svg version
metadata = InkStitchMetadata(svg.getroot())
metadata['inkstitch_svg_version'] = INKSTITCH_SVG_VERSION
def update_legacy_params(element, file_version, inkstitch_svg_version):
for version in range(file_version + 1, inkstitch_svg_version + 1):
_update_to(version, element)
def _update_to(version, element):
if version == 1:
_update_to_one(element)
elif version == 2:
_update_to_two(element)
elif version == 3:
_update_to_three(element)
def _update_to_three(element):
if element.get_boolean_param('satin_column', False):
element.set_param('start_at_nearest_point', False)
element.set_param('end_at_nearest_point', False)
def _update_to_two(element):
if element.node.TAG == "polyline" and element.node.style("stroke") is not None:
element.set_param('stroke_method', 'manual_stitch')
def _update_to_one(element): # noqa: C901
# update legacy embroider_ attributes to namespaced attributes
legacy_attribs = False
for attrib in element.node.attrib:
if attrib.startswith('embroider_'):
_replace_legacy_embroider_param(element, attrib)
legacy_attribs = True
# convert legacy tie setting
legacy_tie = element.get_param('ties', None)
if legacy_tie == "True":
element.set_param('ties', 0)
elif legacy_tie == "False":
element.set_param('ties', 3)
# convert legacy fill_method
legacy_fill_method = element.get_int_param('fill_method', None)
if legacy_fill_method == 0:
element.set_param('fill_method', 'auto_fill')
elif legacy_fill_method == 1:
element.set_param('fill_method', 'contour_fill')
elif legacy_fill_method == 2:
element.set_param('fill_method', 'guided_fill')
elif legacy_fill_method == 3:
element.set_param('fill_method', 'legacy_fill')
underlay_angle = element.get_param('fill_underlay_angle', None)
if underlay_angle and ',' in underlay_angle:
element.set_param('fill_underlay_angle', underlay_angle.replace(',', ' '))
# legacy satin method
if element.get_boolean_param('e_stitch', False) is True:
element.remove_param('e_stitch')
element.set_param('satin_method', 'e_stitch')
if element.get_boolean_param('satin_column', False) or element.get_int_param('stroke_method', 0) == 1:
# reverse_rails defaults to Automatic, but we should never reverse an
# old satin automatically, only new ones
element.set_param('reverse_rails', 'none')
# default setting for fill_underlay has changed
if legacy_attribs and not element.get_param('fill_underlay', ""):
element.set_param('fill_underlay', False)
# default setting for running stitch length has changed (fills and strokes, not satins)
if not element.get_boolean_param('satin_column', False) and element.get_float_param('running_stitch_length_mm', None) is None:
element.set_param('running_stitch_length_mm', 1.5)
# convert legacy stroke_method
if element.get_style("stroke") and not element.node.get('inkscape:connection-start', None):
# manual stitch
legacy_manual_stitch = element.get_boolean_param('manual_stitch', False)
if legacy_manual_stitch is True:
element.remove_param('manual_stitch')
element.set_param('stroke_method', 'manual_stitch')
# stroke_method
legacy_stroke_method = element.get_int_param('stroke_method', None)
if legacy_stroke_method == 0:
element.set_param('stroke_method', 'running_stitch')
elif legacy_stroke_method == 1:
element.set_param('stroke_method', 'ripple_stitch')
if (not element.get_param('stroke_method', None) and
element.get_param('satin_column', False) is False and
not element.node.style('stroke-dasharray')):
element.set_param('stroke_method', 'zigzag_stitch')
# grid_size was supposed to be mm, but it was in pixels
grid_size = element.get_float_param('grid_size', None)
if grid_size:
size = grid_size / PIXELS_PER_MM
size = "{:.2f}".format(size)
element.set_param('grid_size_mm', size)
element.remove_param('grid_size')
def _replace_legacy_embroider_param(element, param):
# remove "embroider_" prefix
new_param = param[10:]
if new_param in INKSTITCH_ATTRIBS:
value = element.node.get(param, "").strip()
element.set_param(param[10:], value)
del element.node.attrib[param]
'''
Update legacy commands
======================
'''
def update_legacy_commands(document):
'''
Changes for svg version 3
'''
search_string = "//svg:symbol"
symbols = document.xpath(search_string)
for symbol in symbols:
_rename_command(document, symbol, 'inkstitch_fill_start', 'starting_point')
_rename_command(document, symbol, 'inkstitch_fill_end', 'ending_point')
_rename_command(document, symbol, 'inkstitch_satin_start', 'autoroute_start')
_rename_command(document, symbol, 'inkstitch_satin_end', 'autoroute_end')
_rename_command(document, symbol, 'inkstitch_run_start', 'autoroute_start')
_rename_command(document, symbol, 'inkstitch_run_end', 'autoroute_end')
_rename_command(document, symbol, 'inkstitch_ripple_target', 'target_point')
def _rename_command(document, symbol, old_name, new_name):
symbol_id = symbol.get_id()
if symbol_id.startswith(old_name):
symbol.getparent().remove(symbol)
ensure_symbol(document, new_name)
_update_command(document, symbol_id, new_name)
def _update_command(document, old_id, new_name):
xpath2 = f"//svg:use[@xlink:href='#{old_id}']"
elements = document.xpath(xpath2)
for element in elements:
element.set('xlink:href', f'#inkstitch_{new_name}')
|
