2025-12-01

extensions/user_default/retopoflow/scripts/__init__.py

@@ -0,0 +1,22 @@
+'''
+Copyright (C) 2023 CG Cookie
+http://cgcookie.com
+hello@cgcookie.com
+
+Created by Jonathan Denning, Jonathan Williamson, and Patrick Moore
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+'''
+
+__all__ = []

extensions/user_default/retopoflow/scripts/convert_docs_for_web.py

@@ -0,0 +1,75 @@
+#!/usr/bin/python3
+
+import os
+import re
+import sys
+import codecs
+
+re_keymap = re.compile(r'{{(?P<key>.*?)}}')
+re_options = re.compile(r'{\[(?P<key>.*?)\]}')
+re_table = re.compile(r'\|(?P<pre> +)(?P<dashes>--+)(?P<post> +)\|')
+
+def read_file(filename):
+    try: return codecs.open(filename, encoding='utf-8').read()
+    except: pass
+    try: return codecs.open(filename, encoding='utf-16').read()
+    except: pass
+    return None
+
+
+if len(sys.argv) != 2:
+    print(f'Usage: {sys.argv[0]} [file.md]')
+    sys.exit(1)
+
+fn = sys.argv[1]
+f = read_file(fn)
+
+# convert keymaps {{something foo, bar}}  ==>  <var_something_foo/>, <var_bar/>
+nf = []
+for l in f.splitlines():
+    while True:
+        m = re_keymap.search(l)
+        if not m: break
+        keys = m.group('key').split(',')
+        nkeys = []
+        for key in keys:
+            key = key.strip()
+            key = key.replace(' ','_')
+            key = f'<var_{key}/>'
+            nkeys += [key]
+        keys = ', '.join(nkeys)
+        l = l[:m.start()] + keys + l[m.end():]
+    nf += [l]
+f = '\n'.join(nf)
+
+# convert options  {[something foo]}  ==>  <var_something_foo/>
+nf = []
+for l in f.splitlines():
+    while True:
+        m = re_options.search(l)
+        if not m: break
+        key = m.group('key')
+        key = key.strip()
+        key = key.replace(' ', '_')
+        key = f'<var_{key}/>'
+        l = l[:m.start()] + key + l[m.end():]
+    nf += [l]
+f = '\n'.join(nf)
+
+# convert tables | --- | --- | --- |  ==>  | :--- | :--- | :--- |
+nf = []
+for l in f.splitlines():
+    while True:
+        m = re_table.search(l)
+        if not m: break
+        l = l[:m.start()] + '|' + m.group('pre') + ':' + m.group('dashes') + m.group('post') + '|' + l[m.end():]
+    nf += [l]
+f = '\n'.join(nf)
+
+f = f + '\n\n'
+
+# print(type(f))
+# print(f)
+
+with open(fn, 'w') as fo:
+    fo.write(f) #.encode('utf8'))

extensions/user_default/retopoflow/scripts/create_thumbnails.py

@@ -0,0 +1,35 @@
+#!/usr/bin/python3
+
+import os
+import png
+import sys
+import glob
+import shutil
+import subprocess
+
+w,h = 120,120
+tempfn = '_temporary.thumb.png'
+
+def same_pngs(fnA, fnB):
+    wA, hA, dA, mA = png.Reader(filename=fnA).read()
+    wB, hB, dB, mB = png.Reader(filename=fnB).read()
+    if (wA, hA) != (wB, hB): return False  # different sizes
+    for rowA, rowB in zip(dA, dB):
+        for colA, colB in zip(rowA, rowB):
+            if colA != colB: return False
+    # not checking meta data (mA == mB)
+    # for example: ignoring the creation timestamp
+    return True
+
+for fullfn in glob.glob('*.png'):
+    if fullfn.endswith('.thumb.png'):
+        # do not thumb the thumb files!
+        continue
+    fullbase, _ = os.path.splitext(fullfn)
+    thumbfn = f'{fullbase}.thumb.png'
+    subprocess.call(f'convert "{fullfn}" -resize {w}x{h} "{tempfn}"', shell=True)
+    if os.path.exists(thumbfn) and same_pngs(tempfn, thumbfn):
+        # pixel data did not change
+        os.remove(tempfn)
+    else:
+        shutil.move(tempfn, thumbfn)

extensions/user_default/retopoflow/scripts/detect_filename_case_conflicts.py

@@ -0,0 +1,31 @@
+#!/usr/bin/python3
+
+import os
+import sys
+import glob
+
+issue = False
+
+def check(path):
+    global issue
+    pwd = os.getcwd()
+    os.chdir(path)
+    filenames = set(glob.glob('*'))
+    lfilenames = {}
+    for f in filenames:
+        lfilenames.setdefault(f.lower(), [])
+        lfilenames[f.lower()].append(f)
+    if any(len(v)>1 for k,v in lfilenames.items()):
+        issue = True
+        print(f'Issues detected in {path}')
+        for k,v in lfilenames.items():
+            if len(v) == 1: continue
+            for f in v: print(f'  {f}')
+    for f in filenames:
+        if not os.path.isdir(f): continue
+        check(os.path.join(path, f))
+    os.chdir(pwd)
+
+check(os.path.abspath('.'))
+
+sys.exit(1 if issue else 0)

extensions/user_default/retopoflow/scripts/download_b280.py

@@ -0,0 +1,45 @@
+#!/usr/bin/python3
+
+import os
+import re
+import glob
+import wget
+import shutil
+import tarfile
+import datetime
+
+assert False, 'do not use this anymore'
+
+now = datetime.datetime.now()
+user = os.path.expanduser('~')
+urlroot='https://builder.blender.org'
+url='%s/download/' % urlroot
+tmp='/tmp/download.html'
+blendertar=os.path.join(user, 'software/blender-2.80-%04d%02d%02d.tar.bz2' % (now.year, now.month, now.day))
+blenderpath=os.path.join(user, 'software/blender-2.80-%04d%02d%02d' % (now.year, now.month, now.day))
+blendersym=os.path.join(user, 'software/blender-2.80')
+
+print('finding latest blender 2.80')
+tmp=wget.download(url=url, out=tmp, bar=None)
+html=open(tmp, 'rt').read()
+m = re.search(r'/download/blender-2\.80-[0-9a-f]+-linux-glibc[^-]*?-x86_64\.tar\.bz2', html)
+assert m, 'could not find match'
+
+url = '%s/%s' % (urlroot, m.group(0))
+print('downloading %s' % url)
+blendertar=wget.download(url=url, out=blendertar, bar=None)
+
+print('extracting from %s' % blendertar)
+t = tarfile.open(name=blendertar)
+t.extractall(path=blenderpath)
+
+innerpath=list(glob.glob(os.path.join(blenderpath,'*')))[0]
+print('moving from inner folder (%s) to outer' % innerpath)
+for f in glob.glob(os.path.join(innerpath, '*')):
+    shutil.move(f, blenderpath)
+os.rmdir(innerpath)
+
+print('creating new symlink and cleaning up')
+os.unlink(blendertar)
+os.unlink(blendersym)
+os.symlink(blenderpath, blendersym)

extensions/user_default/retopoflow/scripts/download_b281.py

@@ -0,0 +1,43 @@
+#!/usr/bin/python3
+
+import os
+import re
+import glob
+import wget
+import shutil
+import tarfile
+import datetime
+
+now = datetime.datetime.now()
+user = os.path.expanduser('~')
+urlroot='https://builder.blender.org'
+url='%s/download/' % urlroot
+tmp='/tmp/download.html'
+blendertar=os.path.join(user, 'software/blender-2.81-%04d%02d%02d.tar.bz2' % (now.year, now.month, now.day))
+blenderpath=os.path.join(user, 'software/blender-2.81-%04d%02d%02d' % (now.year, now.month, now.day))
+blendersym=os.path.join(user, 'software/blender-2.81')
+
+print('finding latest blender 2.81')
+tmp=wget.download(url=url, out=tmp, bar=None)
+html=open(tmp, 'rt').read()
+m = re.search(r'/download/blender-2\.81-[0-9a-f]+-linux-glibc[^-]*?-x86_64\.tar\.bz2', html)
+assert m, 'could not find match'
+
+url = '%s/%s' % (urlroot, m.group(0))
+print('downloading %s' % url)
+blendertar=wget.download(url=url, out=blendertar, bar=None)
+
+print('extracting from %s' % blendertar)
+t = tarfile.open(name=blendertar)
+t.extractall(path=blenderpath)
+
+innerpath=list(glob.glob(os.path.join(blenderpath,'*')))[0]
+print('moving from inner folder (%s) to outer' % innerpath)
+for f in glob.glob(os.path.join(innerpath, '*')):
+    shutil.move(f, blenderpath)
+os.rmdir(innerpath)
+
+print('creating new symlink and cleaning up')
+os.unlink(blendertar)
+os.unlink(blendersym)
+os.symlink(blenderpath, blendersym)

extensions/user_default/retopoflow/scripts/download_b282.py

@@ -0,0 +1,43 @@
+#!/usr/bin/python3
+
+import os
+import re
+import glob
+import wget
+import shutil
+import tarfile
+import datetime
+
+now = datetime.datetime.now()
+user = os.path.expanduser('~')
+urlroot='https://builder.blender.org'
+url='%s/download/' % urlroot
+tmp='/tmp/download.html'
+blendertar=os.path.join(user, 'software/blender-2.82-%04d%02d%02d.tar.bz2' % (now.year, now.month, now.day))
+blenderpath=os.path.join(user, 'software/blender-2.82-%04d%02d%02d' % (now.year, now.month, now.day))
+blendersym=os.path.join(user, 'software/blender-2.82')
+
+print('finding latest blender 2.82')
+tmp=wget.download(url=url, out=tmp, bar=None)
+html=open(tmp, 'rt').read()
+m = re.search(r'/download/blender-2\.82-[0-9a-f]+-linux-glibc[^-]*?-x86_64\.tar\.(bz2|xz)', html)
+assert m, 'could not find match'
+
+url = '%s/%s' % (urlroot, m.group(0))
+print('downloading %s' % url)
+blendertar=wget.download(url=url, out=blendertar, bar=None)
+
+print('extracting from %s' % blendertar)
+t = tarfile.open(name=blendertar)
+t.extractall(path=blenderpath)
+
+innerpath=list(glob.glob(os.path.join(blenderpath,'*')))[0]
+print('moving from inner folder (%s) to outer' % innerpath)
+for f in glob.glob(os.path.join(innerpath, '*')):
+    shutil.move(f, blenderpath)
+os.rmdir(innerpath)
+
+print('creating new symlink and cleaning up')
+os.unlink(blendertar)
+os.unlink(blendersym)
+os.symlink(blenderpath, blendersym)

extensions/user_default/retopoflow/scripts/get_hive_value.py

@@ -0,0 +1,14 @@
+#!/usr/bin/python3
+
+import os
+import sys
+import json
+
+if len(sys.argv) != 2:
+    print(f'Usage: {sys.argv[0]} key')
+    sys.exit(1)
+
+hive_path = os.path.join(os.path.dirname(__file__), '..', 'hive.json')
+hive = json.load(open(hive_path, 'rt'))
+
+print(hive[sys.argv[1]])

extensions/user_default/retopoflow/scripts/memlimited.sh

@@ -0,0 +1,7 @@
+#!/bin/bash -e
+
+# runs blender with limited memory (will crash if blender allocates too much)
+
+ulimit -Sv 5000000
+#shift
+./blender $@

extensions/user_default/retopoflow/scripts/prep_help_for_online.py

@@ -0,0 +1,289 @@
+#!/usr/bin/python3
+
+import os
+import re
+import sys
+import glob
+import json
+import shutil
+import codecs
+
+CLEAR_OLD_DOCS   = False
+DELETE_ALL_OLD   = False
+PROCESS_MARKDOWN = True
+COPY_IMAGES      = True
+
+re_keymap    = re.compile(r'{{(?P<key>.*?)}}')
+re_options   = re.compile(r'{\[(?P<key>.*?)\]}')
+re_table     = re.compile(r'\|(?P<pre> +)(?P<dashes>--+)(?P<post> +)\|')
+re_emptyth   = re.compile(r'\|( +\|){2,}')
+re_notonline = re.compile(r'<label .*?class="not-online".*?>.*?</label>') #  r'<input[^>]*>[^<]*</input>'
+re_image     = re.compile(r'!\[(?P<caption>[^\]]*)\]\((?P<filename>[^ \)]+)(?P<styling>[^\)]*)\)')
+
+def read_file(filename):
+    try: return codecs.open(filename, encoding='utf-8').read()
+    except: pass
+    try: return codecs.open(filename, encoding='utf-16').read()
+    except: pass
+    return None
+
+def write_file(filename, contents):
+    codecs.open(filename, mode='w', encoding='utf-8').write(contents)
+
+def process_mdown(mdown):
+    # convert keymaps {{something foo, bar}}  ==>  {{ keymaps.something_foo }}, {{ keymaps.bar }}
+    nf = []
+    for l in mdown.splitlines():
+        current, remaining = '', l
+        while remaining:
+            m = re_keymap.search(remaining)
+            if not m:
+                current += remaining
+                remaining = ''
+                continue
+            pre, post = remaining[:m.start()], remaining[m.end():]
+            keys = m.group('key').split(',')
+            nkeys = []
+            for key in keys:
+                key = key.strip()
+                key = key.replace(' ','_')
+                key = '{{ site.data.keymaps.%s }}' % key
+                nkeys += [key]
+            keys = ', '.join(nkeys)
+            current += pre + keys
+            remaining = post
+        nf += [current]
+    mdown = '\n'.join(nf)
+
+    # convert options  {[something foo]}  ==>  {{ options.something_foo }}
+    nf = []
+    for l in mdown.splitlines():
+        current, remaining = '', l
+        while remaining:
+            m = re_options.search(remaining)
+            if not m:
+                current += remaining
+                remaining = ''
+                continue
+            pre, post = remaining[:m.start()], remaining[m.end():]
+            key = m.group('key')
+            key = key.strip()
+            key = key.replace(' ', '_')
+            key = '{{ site.data.options.%s }}' % key
+            current += pre + key
+            remaining = post
+        nf += [current]
+    mdown = '\n'.join(nf)
+
+    # convert tables | --- | --- | --- |  ==>  | :--- | :--- | :--- |
+    nf = []
+    for l in mdown.splitlines():
+        while True:
+            m = re_table.search(l)
+            if not m: break
+            l = l[:m.start()] + '|' + m.group('pre') + ':' + m.group('dashes') + m.group('post') + '|' + l[m.end():]
+        nf += [l]
+    mdown = '\n'.join(nf)
+
+    # delete empty table headers
+    mdown = re_emptyth.sub('', mdown)
+
+    # remove inline image styling
+    nf = []
+    for l in mdown.splitlines():
+        current, remaining = '', l
+        while remaining:
+            m = re_image.search(remaining)
+            if not m:
+                current += remaining
+                remaining = ''
+                continue
+            pre, post = remaining[:m.start()], remaining[m.end():]
+            img = f"![{m.group('caption')}]({m.group('filename')})"
+            current += pre + img
+            remaining = post
+        nf += [current]
+    mdown = '\n'.join(nf)
+
+    # remove <label class="not-online">...</label>
+    # found in welcome.md
+    nf = []
+    for l in mdown.splitlines():
+        while True:
+            m = re_notonline.search(l)
+            if not m: break
+            l = l[:m.start()] + l[m.end():]
+        nf += [l]
+    mdown = '\n'.join(nf)
+
+    mdown += '\n\n'
+
+    return mdown
+
+def delete_all(path):
+    ppath = os.getcwd()
+    os.chdir(path)
+    for fn in glob.glob('*'):
+        fn_full = os.path.join(path, fn)
+        if os.path.isdir(fn):
+            delete_all(fn_full)
+        elif fn.endswith('.png'):
+            os.remove(fn_full)
+        elif fn.endswith('.md'):
+            os.remove(fn_full)
+        elif DELETE_ALL_OLD:
+            os.remove(fn_full)
+    os.chdir(ppath)
+    os.rmdir(path)
+
+
+path_here  = os.path.dirname(__file__)
+path_root  = os.path.abspath(os.path.join(path_here, '..'))
+
+path_help        = os.path.join(path_root, 'help')
+path_help_images = os.path.join(path_root, 'help', 'images')
+
+path_help_web_config  = os.path.join(path_root, 'docs_config')
+path_help_web         = os.path.join(path_root, 'docs')
+path_help_web_images  = os.path.join(path_root, 'docs', 'images')
+
+path_icons = os.path.join(path_root, 'icons')
+
+path_keys  = os.path.join(path_root, 'config', 'keymaps.py')
+path_opts  = os.path.join(path_root, 'config', 'options.py')
+path_human = os.path.join(path_root, 'addon_common', 'common', 'human_readable.py')
+
+path_data    = os.path.join(path_help_web, '_data')
+path_keymaps = os.path.join(path_data, 'keymaps.yml')
+path_options = os.path.join(path_data, 'options.yml')
+
+paths_config = {
+    ('CNAME',        os.path.join(path_help_web)),
+    ('Gemfile',      os.path.join(path_help_web)),
+    ('Gemfile.lock', os.path.join(path_help_web)),
+    ('_config.yml',  os.path.join(path_help_web)),
+    ('default.html', os.path.join(path_help_web, '_layouts')),
+    ('main.css',     os.path.join(path_help_web, 'assets', 'css'))
+}
+
+
+os.chdir(path_root)
+
+if CLEAR_OLD_DOCS:
+    # get online docs folder ready
+    if os.path.exists(path_help_web):
+        # clear out old online docs
+        delete_all(path_help_web)
+
+if not os.path.exists(path_help_web):
+    # create folder for online docs
+    os.mkdir(path_help_web)
+if not os.path.exists(path_data):
+    # create jekyll _data folder for variables
+    os.mkdir(path_data)
+
+if PROCESS_MARKDOWN:
+    # process all markdown files
+    os.chdir(path_help)
+    for fn in glob.glob('*.md'):
+        print(f'Processing: {fn}')
+        mdown = read_file(fn)
+        mdown = process_mdown(mdown)
+        write_file(os.path.join(path_help_web, fn), mdown)
+
+if COPY_IMAGES:
+    # copy over PNG files (except for thumbnails)
+    os.chdir(path_help_images)
+    for fn in glob.glob('*.png'):
+        if fn.endswith('.thumb.png'): continue
+        print(f'Copying: {fn}')
+        shutil.copyfile(fn, os.path.join(path_help_web_images, fn))
+    os.chdir(path_icons)
+    for fn in glob.glob('*.png'):
+        if fn.endswith('.thumb.png'): continue
+        print(f'Copying: {fn}')
+        shutil.copyfile(fn, os.path.join(path_help_web_images, fn))
+
+# copy docs config files
+os.chdir(path_help_web_config)
+for fn, path in paths_config:
+    if not os.path.exists(path):
+        os.makedirs(path)
+    shutil.copyfile(fn, os.path.join(path, fn))
+
+
+# load convert_actions_to_human_readable()
+human_readable = read_file(path_human)
+human_readable = '\n'.join(l for l in human_readable.splitlines() if not re.match(r'(from|import) ', l))
+# add platform.system stuff...
+human_readable = f'''
+class platform:
+    @staticmethod
+    def system():
+        return 'Linux'
+
+{human_readable}
+'''
+try:
+    exec(human_readable, globals(), locals())
+except Exception as e:
+    print(f'*****************************************************************')
+    print(f'Caught exception {e} while trying to exec the following:')
+    print(f'')
+    print(human_readable)
+    print(f'')
+    print(f'*****************************************************************')
+    raise e
+
+# load and process default keymaps (assuming LMB Select)
+# NOTE: only reading default_rf_keymaps and left_rf_keymaps
+keymaps = read_file(path_keys)
+keymaps = keymaps[keymaps.index('# start keymaps'):keymaps.index('# end keymaps')]
+exec(keymaps, globals(), locals())
+keymaps = dict(default_rf_keymaps)
+keymaps.update(left_rf_keymaps)
+keymaps.update({
+    'blender save': {'CTRL+S'},
+    'blender undo': {'CTRL+Z'},
+    'blender redo': {'SHIFT+CTRL+Z'},
+})
+keymaps_data = []
+for k,v in keymaps.items():
+    k = k.replace(' ', '_')
+    # f'{pre}{wrap_pre}' + self.actions.to_human_readable(action, sep=f'{wrap_post}{separator}{wrap_pre}', onlyfirst=onlyfirst) + f'{wrap_post}{post}'
+    # v = '`' + convert_actions_to_human_readable(v, sep='`, `') + '`'
+    v = '<code>' + convert_actions_to_human_readable(v, sep='</code>, <code>') + '</code>'
+    keymaps_data.append(f'{k}: "{v}"')
+keymaps_data = '\n'.join(keymaps_data)
+write_file(path_keymaps, keymaps_data)
+
+
+# process hive
+release_short = {
+    'alpha':    'α',
+    'beta':     'β',
+    'official': '',
+}
+hive_path = os.path.join(os.path.dirname(__file__), '..', 'hive.json')
+hive = json.load(open(hive_path, 'rt'))
+version = hive['version']
+release = hive['release']
+
+
+# process options
+grab = [
+    ('warning_max_sources', re.compile(r''''warning max sources' *: *(?P<val>'[^']+'|"[^"]*")''')),
+    ('warning_max_target',  re.compile(r''''warning max target' *: *(?P<val>'[^']+'|"[^"]*")''')),
+]
+options = read_file(path_opts)
+options_data = []
+for k,r in grab:
+    m = r.search(options)
+    if not m:
+        print(f'Could not find match for ({k},{r})')
+        continue
+    options_data.append(f"{k}: {m.group('val')}")
+options_data += [f'rf_version: {version}{release_short[release]}']
+options_data = '\n'.join(options_data)
+write_file(path_options, options_data)
+