def get_shell_script(self, cmd_glob, location=None):
if not location:
location = self.working_dir + '/kalite'
cmd_glob += system_script_extension()
# Find the command
cmd = glob.glob(location + "/" + cmd_glob)
if len(cmd) > 1:
raise CommandError("Multiple commands found (%s)? Should choose based on platform, but ... how to do in Python? Contact us to implement this!" % cmd_glob)
elif len(cmd)==1:
cmd = cmd[0]
else:
cmd = None
logging.warn("No command found: (%s in %s)" % (cmd_glob, location))
return cmd
def get_shell_script(self, cmd_glob, location=None):
if not location:
location = self.working_dir + '/kalite'
cmd_glob += system_script_extension()
# Find the command
cmd = glob.glob(location + "/" + cmd_glob)
if len(cmd) > 1:
raise CommandError("Multiple commands found (%s)? Should choose based on platform, but ... how to do in Python? Contact us to implement this!" % cmd_glob)
elif len(cmd)==1:
cmd = cmd[0]
else:
cmd = None
logging.warn("No command found: (%s in %s)" % (cmd_glob, location))
return cmd
def handle(self, *args, **options):
if not options["interactive"]:
options["username"] = options["username"] or settings.INSTALL_ADMIN_USERNAME or getpass.getuser()
options["hostname"] = options["hostname"] or get_host_name()
sys.stdout.write(" _ __ ___ _ _ _ \n")
sys.stdout.write(" | | / / / _ \ | | (_) | \n")
sys.stdout.write(" | |/ / / /_\ \ | | _| |_ ___ \n")
sys.stdout.write(" | \ | _ | | | | | __/ _ \ \n")
sys.stdout.write(" | |\ \| | | | | |___| | || __/ \n")
sys.stdout.write(" \_| \_/\_| |_/ \_____/_|\__\___| \n")
sys.stdout.write(" \n")
sys.stdout.write("http://kalite.learningequality.org\n")
sys.stdout.write(" \n")
sys.stdout.write(" version %s\n" % version.VERSION)
sys.stdout.write(" \n")
if sys.version_info >= (2,8) or sys.version_info < (2,6):
raise CommandError("You must have Python version 2.6.x or 2.7.x installed. Your version is: %s\n" % sys.version_info)
if options["interactive"]:
sys.stdout.write("--------------------------------------------------------------------------------\n")
sys.stdout.write("\n")
sys.stdout.write("This script will configure the database and prepare it for use.\n")
sys.stdout.write("\n")
sys.stdout.write("--------------------------------------------------------------------------------\n")
sys.stdout.write("\n")
raw_input("Press [enter] to continue...")
sys.stdout.write("\n")
# Tried not to be os-specific, but ... hey. :-/
if not is_windows() and hasattr(os, "getuid") and os.getuid() == 502:
sys.stdout.write("-------------------------------------------------------------------\n")
sys.stdout.write("WARNING: You are installing KA-Lite as root user!\n")
sys.stdout.write("\tInstalling as root may cause some permission problems while running\n")
sys.stdout.write("\tas a normal user in the future.\n")
sys.stdout.write("-------------------------------------------------------------------\n")
if options["interactive"]:
if not raw_input_yn("Do you wish to continue and install it as root?"):
raise CommandError("Aborting script.\n")
sys.stdout.write("\n")
# Check to see if the current user is the owner of the install directory
current_owner = find_owner(BASE_DIR)
current_user = getpass.getuser()
if current_owner != current_user:
raise CommandError("""You are not the owner of this directory!
Please copy all files to a directory that you own and then
re-run this script.""")
if not os.access(BASE_DIR, os.W_OK):
raise CommandError("You do not have permission to write to this directory!")
database_file = settings.DATABASES["default"]["NAME"]
install_clean = True
if os.path.exists(database_file):
# We found an existing database file. By default,
# we will upgrade it; users really need to work hard
# to delete the file (but it's possible, which is nice).
sys.stdout.write("-------------------------------------------------------------------\n")
sys.stdout.write("WARNING: Database file already exists! \n")
sys.stdout.write("-------------------------------------------------------------------\n")
if not options["interactive"] \
or raw_input_yn("Keep database file and upgrade to KA Lite version %s? " % version.VERSION) \
or not raw_input_yn("Remove database file '%s' now? " % database_file) \
or not raw_input_yn("WARNING: all data will be lost! Are you sure? "):
install_clean = False
sys.stdout.write("Upgrading database to KA Lite version %s\n" % version.VERSION)
if install_clean:
# After all, don't delete--just move.
sys.stdout.write("OK. We will run a clean install; \n")
sys.stdout.write("the database file will be moved to a deletable location.\n")
# Do all input at once, at the beginning
if install_clean and options["interactive"]:
if not options["username"] or not options["password"]:
sys.stdout.write("\n")
sys.stdout.write("Please choose a username and password for the admin account on this device.\n")
sys.stdout.write("\tYou must remember this login information, as you will need\n")
sys.stdout.write("\tto enter it to administer this installation of KA Lite.\n")
sys.stdout.write("\n")
(username, password) = get_username_password(options["username"], options["password"])
(hostname, description) = get_hostname_and_description(options["hostname"], options["description"])
else:
username = options["username"] or settings.INSTALL_ADMIN_USERNAME
password = options["password"] or settings.INSTALL_ADMIN_PASSWORD
hostname = options["hostname"]
description = options["description"]
if username and not validate_username(username):
raise CommandError("Username must contain only letters, digits, and underscores, and start with a letter.\n")
########################
# Now do stuff
########################
# Move database file (if exists)
if install_clean and os.path.exists(database_file):
# This is an overwrite install; destroy the old db
dest_file = tempfile.mkstemp()[1]
sys.stdout.write("(Re)moving database file to temp location, starting clean install. Recovery location: %s\n" % dest_file)
shutil.move(database_file, dest_file)
# Got this far, it's OK to stop the server.
import serverstop
# Should clean_pyc for (clean) reinstall purposes
call_command("clean_pyc", interactive=False, verbosity=options.get("verbosity"))
# Migrate the database
call_command("syncdb", interactive=False, verbosity=options.get("verbosity"))
call_command("migrate", merge=True, verbosity=options.get("verbosity"))
# Install data
if install_clean:
# Create device, load on any zone data
call_command("generatekeys", verbosity=options.get("verbosity"))
call_command("initdevice", hostname, description, verbosity=options.get("verbosity"))
else:
# Device exists; load data if required.
#
# Hackish, as this duplicates code from initdevice.
#
if os.path.exists(InitCommand.data_json_file):
# This is a pathway to install zone-based data on a software upgrade.
sys.stdout.write("Loading zone data from '%s'\n" % InitCommand.data_json_file)
load_data_for_offline_install(in_file=InitCommand.data_json_file)
confirm_or_generate_zone()
initialize_facility()
# Create the admin user
if password: # blank password (non-interactive) means don't create a superuser
admin = get_object_or_None(User, username=username)
if not admin:
call_command("createsuperuser", username=username, email="*****@*****.**", interactive=False, verbosity=options.get("verbosity"))
admin = User.objects.get(username=username)
admin.set_password(password)
admin.save()
# Move scripts
for script_name in ["start", "stop", "run_command"]:
script_file = script_name + system_script_extension()
dest_dir = os.path.join(settings.PROJECT_PATH, "..")
src_dir = os.path.join(dest_dir, "scripts")
shutil.copyfile(os.path.join(src_dir, script_file), os.path.join(dest_dir, script_file))
shutil.copystat(os.path.join(src_dir, script_file), os.path.join(dest_dir, script_file))
start_script_path = os.path.realpath(os.path.join(settings.PROJECT_PATH, "..", "start%s" % system_script_extension()))
# Run videoscan, on the distributed server.
if not settings.CENTRAL_SERVER:
sys.stdout.write("Scanning for video files in the content directory (%s)\n" % settings.CONTENT_ROOT)
call_command("videoscan")
# done; notify the user.
sys.stdout.write("\n")
if install_clean:
sys.stdout.write("CONGRATULATIONS! You've finished setting up the KA Lite server software.\n")
sys.stdout.write("\tPlease run '%s' to start the server,\n" % start_script_path)
sys.stdout.write("\tthen load 'http://127.0.0.1:%d/' in your browser to complete the device configuration.\n" % settings.user_facing_port())
else:
sys.stdout.write("CONGRATULATIONS! You've finished updating the KA Lite server software.\n")
sys.stdout.write("\tPlease run '%s' to start the server.\n" % start_script_path)
sys.stdout.write("\n")
def install_from_package(data_json_file, signature_file, zip_file, dest_dir=None, install_files=[]):
"""
NOTE: This docstring (below this line) will be dumped as a README file.
Congratulations on downloading KA Lite! These instructions will help you install KA Lite.
"""
import glob
import os
import shutil
import sys
# Make the true paths
src_dir = os.path.dirname(__file__) or os.getcwd() # necessary on Windows
data_json_file = os.path.join(src_dir, data_json_file)
signature_file = os.path.join(src_dir, signature_file)
zip_file = os.path.join(src_dir, zip_file)
# Validate the unpacked files
for file in [data_json_file, signature_file, zip_file]:
if not os.path.exists(file):
raise Exception("Could not find expected file from zip package: %s" % file)
# get the destination directory
while not dest_dir or not os.path.exists(dest_dir) or raw_input("%s: Directory exists; install? [Y/n] " % dest_dir) not in ["", "y", "Y"]:
if dest_dir and raw_input("%s: Directory does not exist; Create and install? [y/N] " % dest_dir) in ["y","Y"]:
try:
os.makedirs(os.path.realpath(dest_dir)) # can't use ensure_dir; external dependency.
break
except Exception as e:
sys.stderr.write("Failed to create dest dir (%s): %s\n" % (dest_dir, e))
dest_dir = raw_input("Please enter the directory where you'd like to install KA Lite (blank=%s): " % src_dir) or src_dir
# unpack the inner zip to the destination
system_specific_unzipping(zip_file, dest_dir)
sys.stdout.write("\n")
# Copy, so that if the installation fails, it can be restarted
shutil.copy(data_json_file, os.path.join(dest_dir, "kalite/static/data/"))
# Run the setup/start scripts
files = [f for f in glob.glob(os.path.join(dest_dir, "setup*%s" % system_script_extension())) if not "from_zip" in f]
return_code = os.system('"%s"' % files[0])
if return_code:
sys.stderr.write("Failed to set up KA Lite: exit-code = %s" % return_code)
sys.exit(return_code)
return_code = os.system('"%s"' % os.path.join(dest_dir, "start%s" % system_script_extension()))
if return_code:
sys.stderr.write("Failed to start KA Lite: exit-code = %s" % return_code)
sys.exit(return_code)
# move the data file to the expected location
static_zip_dir = os.path.join(dest_dir, "kalite/static/zip")
if not os.path.exists(static_zip_dir):
os.mkdir(static_zip_dir)
shutil.move(zip_file, static_zip_dir)
shutil.move(signature_file, static_zip_dir)
# Remove the remaining install files
os.remove(data_json_file) # was copied in earlier
for f in install_files:
fpath = os.path.join(src_dir, f)
if not os.path.exists(fpath):
continue
try:
os.remove(fpath)
sys.stdout.write("Removed installation file %s\n" % fpath)
except Exception as e:
sys.stderr.write("Failed to delete installation file %s: %s\n" % (fpath, e))
def install_from_package(data_json_file,
signature_file,
zip_file,
dest_dir=None,
install_files=[]):
"""
NOTE: This docstring (below this line) will be dumped as a README file.
Congratulations on downloading KA Lite! These instructions will help you install KA Lite.
"""
import glob
import os
import shutil
import sys
# Make the true paths
src_dir = os.path.dirname(__file__) or os.getcwd() # necessary on Windows
data_json_file = os.path.join(src_dir, data_json_file)
signature_file = os.path.join(src_dir, signature_file)
zip_file = os.path.join(src_dir, zip_file)
# Validate the unpacked files
for file in [data_json_file, signature_file, zip_file]:
if not os.path.exists(file):
raise Exception(
"Could not find expected file from zip package: %s" % file)
# get the destination directory
while not dest_dir or not os.path.exists(dest_dir) or raw_input(
"%s: Directory exists; install? [Y/n] " %
dest_dir) not in ["", "y", "Y"]:
if dest_dir and raw_input(
"%s: Directory does not exist; Create and install? [y/N] " %
dest_dir) in ["y", "Y"]:
try:
os.makedirs(os.path.realpath(
dest_dir)) # can't use ensure_dir; external dependency.
break
except Exception as e:
sys.stderr.write("Failed to create dest dir (%s): %s\n" %
(dest_dir, e))
dest_dir = raw_input(
"Please enter the directory where you'd like to install KA Lite (blank=%s): "
% src_dir) or src_dir
# unpack the inner zip to the destination
system_specific_unzipping(zip_file, dest_dir)
sys.stdout.write("\n")
# Copy, so that if the installation fails, it can be restarted
shutil.copy(data_json_file, os.path.join(dest_dir, "kalite/static/data/"))
# Run the setup/start scripts
files = [
f for f in glob.glob(
os.path.join(dest_dir, "setup*%s" % system_script_extension()))
if not "from_zip" in f
]
return_code = os.system('"%s"' % files[0])
if return_code:
sys.stderr.write("Failed to set up KA Lite: exit-code = %s" %
return_code)
sys.exit(return_code)
return_code = os.system(
'"%s"' % os.path.join(dest_dir, "start%s" % system_script_extension()))
if return_code:
sys.stderr.write("Failed to start KA Lite: exit-code = %s" %
return_code)
sys.exit(return_code)
# move the data file to the expected location
static_zip_dir = os.path.join(dest_dir, "kalite/static/zip")
if not os.path.exists(static_zip_dir):
os.mkdir(static_zip_dir)
shutil.move(zip_file, static_zip_dir)
shutil.move(signature_file, static_zip_dir)
# Remove the remaining install files
os.remove(data_json_file) # was copied in earlier
for f in install_files:
fpath = os.path.join(src_dir, f)
if not os.path.exists(fpath):
continue
try:
os.remove(fpath)
sys.stdout.write("Removed installation file %s\n" % fpath)
except Exception as e:
sys.stderr.write("Failed to delete installation file %s: %s\n" %
(fpath, e))
def handle(self, *args, **options):
if not options["interactive"]:
options["username"] = options[
"username"] or settings.INSTALL_ADMIN_USERNAME or getpass.getuser(
)
options["hostname"] = options["hostname"] or get_host_name()
sys.stdout.write(" _ __ ___ _ _ _ \n")
sys.stdout.write(" | | / / / _ \ | | (_) | \n")
sys.stdout.write(" | |/ / / /_\ \ | | _| |_ ___ \n")
sys.stdout.write(" | \ | _ | | | | | __/ _ \ \n")
sys.stdout.write(" | |\ \| | | | | |___| | || __/ \n")
sys.stdout.write(" \_| \_/\_| |_/ \_____/_|\__\___| \n")
sys.stdout.write(" \n")
sys.stdout.write("http://kalite.learningequality.org\n")
sys.stdout.write(" \n")
sys.stdout.write(" version %s\n" % version.VERSION)
sys.stdout.write(" \n")
if sys.version_info >= (2, 8) or sys.version_info < (2, 6):
raise CommandError(
"You must have Python version 2.6.x or 2.7.x installed. Your version is: %s\n"
% sys.version_info)
if options["interactive"]:
sys.stdout.write(
"--------------------------------------------------------------------------------\n"
)
sys.stdout.write("\n")
sys.stdout.write(
"This script will configure the database and prepare it for use.\n"
)
sys.stdout.write("\n")
sys.stdout.write(
"--------------------------------------------------------------------------------\n"
)
sys.stdout.write("\n")
raw_input("Press [enter] to continue...")
sys.stdout.write("\n")
# Tried not to be os-specific, but ... hey. :-/
if not is_windows() and hasattr(os, "getuid") and os.getuid() == 502:
sys.stdout.write(
"-------------------------------------------------------------------\n"
)
sys.stdout.write(
"WARNING: You are installing KA-Lite as root user!\n")
sys.stdout.write(
"\tInstalling as root may cause some permission problems while running\n"
)
sys.stdout.write("\tas a normal user in the future.\n")
sys.stdout.write(
"-------------------------------------------------------------------\n"
)
if options["interactive"]:
if not raw_input_yn(
"Do you wish to continue and install it as root?"):
raise CommandError("Aborting script.\n")
sys.stdout.write("\n")
# Check to see if the current user is the owner of the install directory
current_owner = find_owner(BASE_DIR)
current_user = getpass.getuser()
if current_owner != current_user:
raise CommandError("""You are not the owner of this directory!
Please copy all files to a directory that you own and then
re-run this script.""")
if not os.access(BASE_DIR, os.W_OK):
raise CommandError(
"You do not have permission to write to this directory!")
database_file = settings.DATABASES["default"]["NAME"]
install_clean = True
if os.path.exists(database_file):
# We found an existing database file. By default,
# we will upgrade it; users really need to work hard
# to delete the file (but it's possible, which is nice).
sys.stdout.write(
"-------------------------------------------------------------------\n"
)
sys.stdout.write("WARNING: Database file already exists! \n")
sys.stdout.write(
"-------------------------------------------------------------------\n"
)
if not options["interactive"] \
or raw_input_yn("Keep database file and upgrade to KA Lite version %s? " % version.VERSION) \
or not raw_input_yn("Remove database file '%s' now? " % database_file) \
or not raw_input_yn("WARNING: all data will be lost! Are you sure? "):
install_clean = False
sys.stdout.write("Upgrading database to KA Lite version %s\n" %
version.VERSION)
if install_clean:
# After all, don't delete--just move.
sys.stdout.write("OK. We will run a clean install; \n")
sys.stdout.write(
"the database file will be moved to a deletable location.\n"
)
# Do all input at once, at the beginning
if install_clean and options["interactive"]:
if not options["username"] or not options["password"]:
sys.stdout.write("\n")
sys.stdout.write(
"Please choose a username and password for the admin account on this device.\n"
)
sys.stdout.write(
"\tYou must remember this login information, as you will need\n"
)
sys.stdout.write(
"\tto enter it to administer this installation of KA Lite.\n"
)
sys.stdout.write("\n")
(username,
password) = get_username_password(options["username"],
options["password"])
(hostname, description) = get_hostname_and_description(
options["hostname"], options["description"])
else:
username = options["username"] or settings.INSTALL_ADMIN_USERNAME
password = options["password"] or settings.INSTALL_ADMIN_PASSWORD
hostname = options["hostname"]
description = options["description"]
if username and not validate_username(username):
raise CommandError(
"Username must contain only letters, digits, and underscores, and start with a letter.\n"
)
########################
# Now do stuff
########################
# Move database file (if exists)
if install_clean and os.path.exists(database_file):
# This is an overwrite install; destroy the old db
dest_file = tempfile.mkstemp()[1]
sys.stdout.write(
"(Re)moving database file to temp location, starting clean install. Recovery location: %s\n"
% dest_file)
shutil.move(database_file, dest_file)
# Got this far, it's OK to stop the server.
import serverstop
# Should clean_pyc for (clean) reinstall purposes
call_command("clean_pyc",
interactive=False,
verbosity=options.get("verbosity"))
# Migrate the database
call_command("syncdb",
interactive=False,
verbosity=options.get("verbosity"))
call_command("migrate", merge=True, verbosity=options.get("verbosity"))
# Install data
if install_clean:
# Create device, load on any zone data
call_command("generatekeys", verbosity=options.get("verbosity"))
call_command("initdevice",
hostname,
description,
verbosity=options.get("verbosity"))
else:
# Device exists; load data if required.
#
# Hackish, as this duplicates code from initdevice.
#
if os.path.exists(InitCommand.data_json_file):
# This is a pathway to install zone-based data on a software upgrade.
sys.stdout.write("Loading zone data from '%s'\n" %
InitCommand.data_json_file)
load_data_for_offline_install(
in_file=InitCommand.data_json_file)
confirm_or_generate_zone()
initialize_facility()
# Create the admin user
if password: # blank password (non-interactive) means don't create a superuser
admin = get_object_or_None(User, username=username)
if not admin:
call_command("createsuperuser",
username=username,
email="*****@*****.**",
interactive=False,
verbosity=options.get("verbosity"))
admin = User.objects.get(username=username)
admin.set_password(password)
admin.save()
# Move scripts
for script_name in ["start", "stop", "run_command"]:
script_file = script_name + system_script_extension()
dest_dir = os.path.join(settings.PROJECT_PATH, "..")
src_dir = os.path.join(dest_dir, "scripts")
shutil.copyfile(os.path.join(src_dir, script_file),
os.path.join(dest_dir, script_file))
shutil.copystat(os.path.join(src_dir, script_file),
os.path.join(dest_dir, script_file))
start_script_path = os.path.realpath(
os.path.join(settings.PROJECT_PATH, "..",
"start%s" % system_script_extension()))
# Run videoscan, on the distributed server.
if not settings.CENTRAL_SERVER:
sys.stdout.write(
"Scanning for video files in the content directory (%s)\n" %
settings.CONTENT_ROOT)
call_command("videoscan")
# done; notify the user.
sys.stdout.write("\n")
if install_clean:
sys.stdout.write(
"CONGRATULATIONS! You've finished setting up the KA Lite server software.\n"
)
sys.stdout.write("\tPlease run '%s' to start the server,\n" %
start_script_path)
sys.stdout.write(
"\tthen load 'http://127.0.0.1:%d/' in your browser to complete the device configuration.\n"
% settings.user_facing_port())
else:
sys.stdout.write(
"CONGRATULATIONS! You've finished updating the KA Lite server software.\n"
)
sys.stdout.write("\tPlease run '%s' to start the server.\n" %
start_script_path)
sys.stdout.write("\n")