2022-10-31 22:36:45 +08:00
import json
import os . path
import shutil
import sys
import time
import traceback
import git
import gradio as gr
import html
2022-11-14 02:39:41 +08:00
import shutil
import errno
2022-10-31 22:36:45 +08:00
from modules import extensions , shared , paths
2022-11-01 14:59:00 +08:00
available_extensions = { " extensions " : [ ] }
2022-10-31 23:33:44 +08:00
def check_access ( ) :
2022-12-02 18:53:26 +08:00
assert not shared . cmd_opts . disable_extension_access , " extension access disabled because of command line flags "
2022-10-31 23:33:44 +08:00
2022-10-31 22:36:45 +08:00
def apply_and_restart ( disable_list , update_list ) :
2022-10-31 23:33:44 +08:00
check_access ( )
2022-10-31 22:36:45 +08:00
disabled = json . loads ( disable_list )
assert type ( disabled ) == list , f " wrong disable_list data for apply_and_restart: { disable_list } "
update = json . loads ( update_list )
assert type ( update ) == list , f " wrong update_list data for apply_and_restart: { update_list } "
update = set ( update )
for ext in extensions . extensions :
if ext . name not in update :
continue
try :
2022-11-13 02:44:42 +08:00
ext . fetch_and_reset_hard ( )
2022-10-31 22:36:45 +08:00
except Exception :
2022-11-13 02:44:42 +08:00
print ( f " Error getting updates for { ext . name } : " , file = sys . stderr )
2022-10-31 22:36:45 +08:00
print ( traceback . format_exc ( ) , file = sys . stderr )
shared . opts . disabled_extensions = disabled
shared . opts . save ( shared . config_filename )
shared . state . interrupt ( )
shared . state . need_restart = True
def check_updates ( ) :
2022-10-31 23:33:44 +08:00
check_access ( )
2022-10-31 22:36:45 +08:00
for ext in extensions . extensions :
if ext . remote is None :
continue
try :
ext . check_updates ( )
except Exception :
print ( f " Error checking updates for { ext . name } : " , file = sys . stderr )
print ( traceback . format_exc ( ) , file = sys . stderr )
return extension_table ( )
def extension_table ( ) :
code = f """ <!-- { time . time ( ) } -->
< table id = " extensions " >
< thead >
< tr >
< th > < abbr title = " Use checkbox to enable the extension; it will be enabled or disabled when you click apply button " > Extension < / abbr > < / th >
< th > URL < / th >
< th > < abbr title = " Use checkbox to mark the extension for update; it will be updated when you click apply button " > Update < / abbr > < / th >
< / tr >
< / thead >
< tbody >
"""
for ext in extensions . extensions :
2022-12-03 23:06:33 +08:00
remote = " "
if ext . is_builtin :
remote = " built-in "
elif ext . remote :
remote = f """ <a href= " { html . escape ( ext . remote or ' ' ) } " target= " _blank " > { html . escape ( " built-in " if ext . is_builtin else ext . remote or ' ' ) } </a> """
2022-10-31 22:36:45 +08:00
if ext . can_update :
ext_status = f """ <label><input class= " gr-check-radio gr-checkbox " name= " update_ { html . escape ( ext . name ) } " checked= " checked " type= " checkbox " > { html . escape ( ext . status ) } </label> """
else :
ext_status = ext . status
code + = f """
< tr >
< td > < label > < input class = " gr-check-radio gr-checkbox " name = " enable_ { html.escape(ext.name)} " type = " checkbox " { ' checked= " checked " ' if ext . enabled else ' ' } > { html . escape ( ext . name ) } < / label > < / td >
2022-12-03 23:06:33 +08:00
< td > { remote } < / td >
2022-10-31 22:36:45 +08:00
< td { ' class= " extension_status " ' if ext . remote is not None else ' ' } > { ext_status } < / td >
< / tr >
"""
code + = """
< / tbody >
< / table >
"""
return code
2022-11-01 14:59:00 +08:00
def normalize_git_url ( url ) :
if url is None :
return " "
url = url . replace ( " .git " , " " )
return url
2022-10-31 22:36:45 +08:00
def install_extension_from_url ( dirname , url ) :
2022-10-31 23:33:44 +08:00
check_access ( )
2022-10-31 22:36:45 +08:00
assert url , ' No URL specified '
if dirname is None or dirname == " " :
* parts , last_part = url . split ( ' / ' )
2022-11-01 14:59:00 +08:00
last_part = normalize_git_url ( last_part )
2022-10-31 22:36:45 +08:00
dirname = last_part
target_dir = os . path . join ( extensions . extensions_dir , dirname )
assert not os . path . exists ( target_dir ) , f ' Extension directory already exists: { target_dir } '
2022-11-01 14:59:00 +08:00
normalized_url = normalize_git_url ( url )
assert len ( [ x for x in extensions . extensions if normalize_git_url ( x . remote ) == normalized_url ] ) == 0 , ' Extension with this URL is already installed '
2022-10-31 22:36:45 +08:00
tmpdir = os . path . join ( paths . script_path , " tmp " , dirname )
try :
shutil . rmtree ( tmpdir , True )
repo = git . Repo . clone_from ( url , tmpdir )
repo . remote ( ) . fetch ( )
2022-11-14 02:39:41 +08:00
try :
os . rename ( tmpdir , target_dir )
except OSError as err :
# TODO what does this do on windows? I think it'll be a different error code but I don't have a system to check it
# Shouldn't cause any new issues at least but we probably want to handle it there too.
if err . errno == errno . EXDEV :
# Cross device link, typical in docker or when tmp/ and extensions/ are on different file systems
# Since we can't use a rename, do the slower but more versitile shutil.move()
shutil . move ( tmpdir , target_dir )
else :
# Something else, not enough free space, permissions, etc. rethrow it so that it gets handled.
raise ( err )
2022-10-31 22:36:45 +08:00
2022-11-12 16:11:47 +08:00
import launch
launch . run_extension_installer ( target_dir )
2022-10-31 22:36:45 +08:00
extensions . list_extensions ( )
return [ extension_table ( ) , html . escape ( f " Installed into { target_dir } . Use Installed tab to restart. " ) ]
finally :
shutil . rmtree ( tmpdir , True )
2023-01-06 17:32:44 +08:00
def install_extension_from_index ( url , hide_tags , sort_column ) :
2022-11-01 14:59:00 +08:00
ext_table , message = install_extension_from_url ( None , url )
2023-01-06 17:32:44 +08:00
code , _ = refresh_available_extensions_from_data ( hide_tags , sort_column )
2022-11-01 14:59:00 +08:00
2022-11-06 15:12:53 +08:00
return code , ext_table , message
2022-11-01 14:59:00 +08:00
2022-11-06 15:12:53 +08:00
2023-01-06 17:32:44 +08:00
def refresh_available_extensions ( url , hide_tags , sort_column ) :
2022-11-01 14:59:00 +08:00
global available_extensions
import urllib . request
with urllib . request . urlopen ( url ) as response :
text = response . read ( )
available_extensions = json . loads ( text )
2023-01-06 17:32:44 +08:00
code , tags = refresh_available_extensions_from_data ( hide_tags , sort_column )
2022-11-06 15:12:53 +08:00
return url , code , gr . CheckboxGroup . update ( choices = tags ) , ' '
2023-01-06 17:32:44 +08:00
def refresh_available_extensions_for_tags ( hide_tags , sort_column ) :
code , _ = refresh_available_extensions_from_data ( hide_tags , sort_column )
2022-11-01 14:59:00 +08:00
2022-11-06 15:12:53 +08:00
return code , ' '
2022-11-01 14:59:00 +08:00
2022-11-06 15:12:53 +08:00
2023-01-06 17:32:44 +08:00
sort_ordering = [
# (reverse, order_by_function)
( True , lambda x : x . get ( ' added ' , ' z ' ) ) ,
( False , lambda x : x . get ( ' added ' , ' z ' ) ) ,
( False , lambda x : x . get ( ' name ' , ' z ' ) ) ,
( True , lambda x : x . get ( ' name ' , ' z ' ) ) ,
( False , lambda x : ' z ' ) ,
]
def refresh_available_extensions_from_data ( hide_tags , sort_column ) :
2022-11-01 14:59:00 +08:00
extlist = available_extensions [ " extensions " ]
installed_extension_urls = { normalize_git_url ( extension . remote ) : extension . name for extension in extensions . extensions }
2022-11-06 15:12:53 +08:00
tags = available_extensions . get ( " tags " , { } )
tags_to_hide = set ( hide_tags )
hidden = 0
2022-11-01 14:59:00 +08:00
code = f """ <!-- { time . time ( ) } -->
< table id = " available_extensions " >
< thead >
< tr >
< th > Extension < / th >
< th > Description < / th >
< th > Action < / th >
< / tr >
< / thead >
< tbody >
"""
2023-01-06 17:32:44 +08:00
sort_reverse , sort_function = sort_ordering [ sort_column if 0 < = sort_column < len ( sort_ordering ) else 0 ]
for ext in sorted ( extlist , key = sort_function , reverse = sort_reverse ) :
2022-11-01 14:59:00 +08:00
name = ext . get ( " name " , " noname " )
2023-01-06 17:32:44 +08:00
added = ext . get ( ' added ' , ' unknown ' )
2022-11-01 14:59:00 +08:00
url = ext . get ( " url " , None )
description = ext . get ( " description " , " " )
2022-11-06 15:12:53 +08:00
extension_tags = ext . get ( " tags " , [ ] )
2022-11-01 14:59:00 +08:00
if url is None :
continue
2022-12-10 20:05:22 +08:00
existing = installed_extension_urls . get ( normalize_git_url ( url ) , None )
extension_tags = extension_tags + [ " installed " ] if existing else extension_tags
2022-11-06 15:12:53 +08:00
if len ( [ x for x in extension_tags if x in tags_to_hide ] ) > 0 :
hidden + = 1
continue
2022-11-01 14:59:00 +08:00
install_code = f """ <input onclick= " install_extension_from_index(this, ' { html . escape ( url ) } ' ) " type= " button " value= " { " Install " if not existing else " Installed " } " { " disabled=disabled " if existing else " " } class= " gr-button gr-button-lg gr-button-secondary " > """
2022-11-06 15:12:53 +08:00
tags_text = " , " . join ( [ f " <span class= ' extension-tag ' title= ' { tags . get ( x , ' ' ) } ' > { x } </span> " for x in extension_tags ] )
2022-11-01 14:59:00 +08:00
code + = f """
< tr >
2022-11-06 15:12:53 +08:00
< td > < a href = " { html.escape(url)} " target = " _blank " > { html . escape ( name ) } < / a > < br / > { tags_text } < / td >
2023-01-06 17:32:44 +08:00
< td > { html . escape ( description ) } < p class = " info " > < span class = " date_added " > Added : { html . escape ( added ) } < / span > < / p > < / td >
2022-11-01 14:59:00 +08:00
< td > { install_code } < / td >
< / tr >
2022-12-10 20:05:22 +08:00
"""
for tag in [ x for x in extension_tags if x not in tags ] :
tags [ tag ] = tag
2022-11-01 14:59:00 +08:00
code + = """
< / tbody >
< / table >
"""
2022-11-06 15:12:53 +08:00
if hidden > 0 :
code + = f " <p>Extension hidden: { hidden } </p> "
return code , list ( tags )
2022-11-01 14:59:00 +08:00
2022-10-31 22:36:45 +08:00
def create_ui ( ) :
import modules . ui
with gr . Blocks ( analytics_enabled = False ) as ui :
with gr . Tabs ( elem_id = " tabs_extensions " ) as tabs :
with gr . TabItem ( " Installed " ) :
with gr . Row ( ) :
apply = gr . Button ( value = " Apply and restart UI " , variant = " primary " )
check = gr . Button ( value = " Check for updates " )
2022-11-01 14:59:00 +08:00
extensions_disabled_list = gr . Text ( elem_id = " extensions_disabled_list " , visible = False ) . style ( container = False )
extensions_update_list = gr . Text ( elem_id = " extensions_update_list " , visible = False ) . style ( container = False )
2022-10-31 22:36:45 +08:00
extensions_table = gr . HTML ( lambda : extension_table ( ) )
apply . click (
fn = apply_and_restart ,
_js = " extensions_apply " ,
inputs = [ extensions_disabled_list , extensions_update_list ] ,
outputs = [ ] ,
)
check . click (
fn = check_updates ,
_js = " extensions_check " ,
inputs = [ ] ,
outputs = [ extensions_table ] ,
)
2022-11-01 14:59:00 +08:00
with gr . TabItem ( " Available " ) :
with gr . Row ( ) :
refresh_available_extensions_button = gr . Button ( value = " Load from: " , variant = " primary " )
available_extensions_index = gr . Text ( value = " https://raw.githubusercontent.com/wiki/AUTOMATIC1111/stable-diffusion-webui/Extensions-index.md " , label = " Extension index URL " ) . style ( container = False )
extension_to_install = gr . Text ( elem_id = " extension_to_install " , visible = False )
install_extension_button = gr . Button ( elem_id = " install_extension_button " , visible = False )
2022-11-06 15:12:53 +08:00
with gr . Row ( ) :
2022-12-10 20:05:22 +08:00
hide_tags = gr . CheckboxGroup ( value = [ " ads " , " localization " , " installed " ] , label = " Hide extensions with tags " , choices = [ " script " , " ads " , " localization " , " installed " ] )
2023-01-06 17:32:44 +08:00
sort_column = gr . Radio ( value = " newest first " , label = " Order " , choices = [ " newest first " , " oldest first " , " a-z " , " z-a " , " internal order " , ] , type = " index " )
2022-11-06 15:12:53 +08:00
2022-11-01 14:59:00 +08:00
install_result = gr . HTML ( )
available_extensions_table = gr . HTML ( )
refresh_available_extensions_button . click (
2022-11-06 15:12:53 +08:00
fn = modules . ui . wrap_gradio_call ( refresh_available_extensions , extra_outputs = [ gr . update ( ) , gr . update ( ) , gr . update ( ) ] ) ,
2023-01-06 17:32:44 +08:00
inputs = [ available_extensions_index , hide_tags , sort_column ] ,
2022-11-06 15:12:53 +08:00
outputs = [ available_extensions_index , available_extensions_table , hide_tags , install_result ] ,
2022-11-01 14:59:00 +08:00
)
install_extension_button . click (
fn = modules . ui . wrap_gradio_call ( install_extension_from_index , extra_outputs = [ gr . update ( ) , gr . update ( ) ] ) ,
2023-01-06 17:32:44 +08:00
inputs = [ extension_to_install , hide_tags , sort_column ] ,
2022-11-01 14:59:00 +08:00
outputs = [ available_extensions_table , extensions_table , install_result ] ,
)
2022-11-06 15:12:53 +08:00
hide_tags . change (
fn = modules . ui . wrap_gradio_call ( refresh_available_extensions_for_tags , extra_outputs = [ gr . update ( ) ] ) ,
2023-01-06 17:32:44 +08:00
inputs = [ hide_tags , sort_column ] ,
outputs = [ available_extensions_table , install_result ]
)
sort_column . change (
fn = modules . ui . wrap_gradio_call ( refresh_available_extensions_for_tags , extra_outputs = [ gr . update ( ) ] ) ,
inputs = [ hide_tags , sort_column ] ,
2022-11-06 15:12:53 +08:00
outputs = [ available_extensions_table , install_result ]
)
2022-10-31 22:36:45 +08:00
with gr . TabItem ( " Install from URL " ) :
install_url = gr . Text ( label = " URL for extension ' s git repository " )
install_dirname = gr . Text ( label = " Local directory name " , placeholder = " Leave empty for auto " )
2022-11-01 14:59:00 +08:00
install_button = gr . Button ( value = " Install " , variant = " primary " )
install_result = gr . HTML ( elem_id = " extension_install_result " )
2022-10-31 22:36:45 +08:00
2022-11-01 14:59:00 +08:00
install_button . click (
2022-10-31 22:36:45 +08:00
fn = modules . ui . wrap_gradio_call ( install_extension_from_url , extra_outputs = [ gr . update ( ) ] ) ,
inputs = [ install_dirname , install_url ] ,
2022-11-01 14:59:00 +08:00
outputs = [ extensions_table , install_result ] ,
2022-10-31 22:36:45 +08:00
)
return ui