forked from unknown-horizons/unknown-horizons
-
Notifications
You must be signed in to change notification settings - Fork 0
/
run_uh.py
executable file
·543 lines (468 loc) · 21 KB
/
run_uh.py
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
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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
#!/usr/bin/env python
# ###################################################
# Copyright (C) 2012 The Unknown Horizons Team
# team@unknown-horizons.org
# This file is part of Unknown Horizons.
#
# Unknown Horizons 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 2 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, write to the
# Free Software Foundation, Inc.,
# 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
# ###################################################
"""TUTORIAL: Welcome to the Unknown Horizons in-code tutorial!
This is a guide for people who are interested in how the code works.
All parts of it are marked with 'TUTORIAL', every entry contains a pointer
to the next step. Have fun :-)
This is the Unknown Horizons launcher, it looks for FIFE and tries
to start the game. You usually don't need to work with this directly.
If you want to dig into the game, continue to horizons/main.py. """
__all__ = ['init_environment', 'get_fife_path']
import sys
import os
import os.path
import gettext
import time
import functools
import locale
import logging
import logging.config
import logging.handlers
import optparse
import signal
import traceback
import platform
import struct
# NOTE: do NOT import anything from horizons.* into global scope
# this will break any run_uh imports from other locations (e.g. _get_version())
def show_error_message(title, message):
print(title)
print(message)
try:
import tkinter
import tkinter.messagebox
window = tkinter.Tk()
window.wm_withdraw()
tkinter.messagebox.showerror(title, message)
except:
# tkinter may be missing
pass
exit(1)
if __name__ == '__main__':
if platform.python_version_tuple()[0] != '2':
show_error_message('Unsupported Python version', 'Python 2 is required to run Unknown Horizons.')
def log():
"""Returns Logger"""
return logging.getLogger("run_uh")
logfilename = None
logfile = None
def find_uh_position():
"""Returns path, where uh is located"""
# first check around cur dir and sys.argv[0]
for i in (
os.path.split(sys.argv[0])[0],
'.', '..'
):
i = os.path.realpath(i)
if os.path.exists( os.path.join(i, 'content')):
return i
else:
# also check system wide dirs
positions = (
'/usr/share/games',
'/usr/share',
'/usr/local/share/games',
'/usr/local/share'
)
for i in positions:
pos = os.path.join(i, 'unknown-horizons')
if os.path.exists( pos ):
return pos
raise RuntimeError('Cannot find location of Unknown Horizons.')
def get_option_parser():
"""Returns inited OptionParser object"""
from horizons.constants import VERSION
p = optparse.OptionParser(usage="%prog [options]", version=VERSION.string())
p.add_option("-d", "--debug", dest="debug", action="store_true", \
default=False, help="Enable debug output to stderr and a logfile.")
p.add_option("--fife-path", dest="fife_path", metavar="<path>", \
help="Specify the path to FIFE root directory.")
p.add_option("--restore-settings", dest="restore_settings", action="store_true", \
default=False, help="Restores the default settings. Useful if Unknown Horizons crashes on startup due to misconfiguration.")
p.add_option("--mp-master", dest="mp_master", metavar="<ip:port>", \
help="Specify alternative multiplayer master server.")
p.add_option("--mp-bind", dest="mp_bind", metavar="<ip:port>", \
help="Specify network address to bind local network client to. This is useful if NAT holepunching is not working but you can forward a static port.")
start_uh_group = optparse.OptionGroup(p, "Starting Unknown Horizons")
start_uh_group.add_option("--start-map", dest="start_map", metavar="<map>", \
help="Starts <map>. <map> is the mapname.")
start_uh_group.add_option("--start-random-map", dest="start_random_map", action="store_true", \
help="Starts a random map.")
start_uh_group.add_option("--start-specific-random-map", dest="start_specific_random_map", metavar="<seed>", \
help="Starts a random map with seed <seed>.")
start_uh_group.add_option("--start-scenario", dest="start_scenario", metavar="<scenario>", \
help="Starts <scenario>. <scenario> is the scenarioname.")
start_uh_group.add_option("--start-campaign", dest="start_campaign", metavar="<campaign>", \
help="Starts <campaign>. <campaign> is the campaign name.")
start_uh_group.add_option("--start-dev-map", dest="start_dev_map", action="store_true", \
default=False, help="Starts the development map without displaying the main menu.")
start_uh_group.add_option("--load-map", dest="load_map", metavar="<save>", \
help="Loads a saved game. <save> is the savegamename.")
start_uh_group.add_option("--load-last-quicksave", dest="load_quicksave", action="store_true", \
help="Loads the last quicksave.")
start_uh_group.add_option("--nature-seed", dest="nature_seed", type="int", \
help="Sets the seed used to generate trees, fish, and other natural resources.")
p.add_option_group(start_uh_group)
ai_group = optparse.OptionGroup(p, "AI options")
ai_group.add_option("--ai-players", dest="ai_players", metavar="<ai_players>", type="int", default=0, \
help="Uses <ai_players> AI players (excludes the possible human-AI hybrid; defaults to 0).")
ai_group.add_option("--human-ai-hybrid", dest="human_ai", action="store_true", \
help="Makes the human player a human-AI hybrid (for development only).")
ai_group.add_option("--force-player-id", dest="force_player_id", metavar="<force_player_id>", type="int", default=None, \
help="Set the player with id <force_player_id> as the active (human) player.")
ai_group.add_option("--ai-highlights", dest="ai_highlights", action="store_true", \
help="Shows AI plans as highlights (for development only).")
p.add_option_group(ai_group)
dev_group = optparse.OptionGroup(p, "Development options")
dev_group.add_option("--debug-log-only", dest="debug_log_only", action="store_true", \
default=False, help="Write debug output only to logfile, not to console. Implies -d.")
dev_group.add_option("--debug-module", action="append", dest="debug_module", \
metavar="<module>", default=[], \
help="Enable logging for a certain logging module (for developing only).")
dev_group.add_option("--logfile", dest="logfile", metavar="<filename>",
help="Writes log to <filename> instead of to the uh-userdir")
dev_group.add_option("--fife-in-library-path", dest="fife_in_library_path", action="store_true", \
default=False, help="For internal use only.")
dev_group.add_option("--profile", dest="profile", action="store_true", \
default=False, help="Enable profiling (for developing only).")
dev_group.add_option("--max-ticks", dest="max_ticks", metavar="<max_ticks>", type="int", \
help="Run the game for <max_ticks> ticks.")
dev_group.add_option("--string-previewer", dest="stringpreview", action="store_true", \
default=False, help="Enable the string previewer tool for scenario writers")
dev_group.add_option("--no-preload", dest="nopreload", action="store_true", \
default=False, help="Disable preloading while in main menu")
dev_group.add_option("--game-speed", dest="gamespeed", metavar="<game_speed>", type="int", \
help="Run the game in the given speed (Values: 0.5, 1, 2, 3, 4, 6, 8, 11, 20)")
dev_group.add_option("--gui-test", dest="gui_test", metavar="<test>", \
default=False, help="INTERNAL. Use run_tests.py instead.")
dev_group.add_option("--gui-log", dest="log_gui", action="store_true", default=False, help="Log gui interactions")
dev_group.add_option("--sp-seed", dest="sp_seed", metavar="<seed>", type="int", \
help="Use this seed for singleplayer sessions.")
dev_group.add_option("--generate-minimap", dest="generate_minimap", \
metavar="<parameters>", help="Generate a minimap for a map")
dev_group.add_option("--create-mp-game", action="store_true", dest="create_mp_game", \
help="Create an multiplayer game with default settings.")
dev_group.add_option("--join-mp-game", action="store_true", dest="join_mp_game", \
help="Join first multiplayer game.")
dev_group.add_option("--interactive-shell", action="store_true", dest="interactive_shell",
help="Starts an IPython kernel. Connect to the shell with: ipython console --existing")
p.add_option_group(dev_group)
return p
def create_user_dirs():
"""Creates the userdir and subdirs. Includes from horizons."""
from horizons.constants import PATHS
for directory in (PATHS.USER_DIR, PATHS.LOG_DIR, PATHS.SCREENSHOT_DIR):
if not os.path.isdir(directory):
os.makedirs(directory)
def excepthook_creator(outfilename):
"""Returns an excepthook function to replace sys.excepthook.
The returned function does the same as the default, except it also prints the traceback
to a file.
@param outfilename: a filename to append traceback to"""
def excepthook(exception_type, value, tb):
f = open(outfilename, 'a')
traceback.print_exception(exception_type, value, tb, file=f)
traceback.print_exception(exception_type, value, tb)
print('')
print(_('Unknown Horizons has crashed.'))
print('')
print(_('We are very sorry for this and want to fix underlying error.'))
print(_('In order to do this, we need the information from the logfile:'))
print(outfilename)
print(_('Please give it to us via IRC or our forum, for both see http://unknown-horizons.org .'))
return excepthook
def exithandler(exitcode, signum, frame):
"""Handles a kill quietly"""
signal.signal(signal.SIGINT, signal.SIG_IGN)
signal.signal(signal.SIGTERM, signal.SIG_IGN)
print('')
print('Oh my god! They killed UH.')
print('You bastards!')
if logfile:
logfile.close()
sys.exit(exitcode)
def main():
# abort silently on signal
signal.signal(signal.SIGINT, functools.partial(exithandler, 130))
signal.signal(signal.SIGTERM, functools.partial(exithandler, 1))
# use locale-specific time.strftime handling
locale.setlocale(locale.LC_TIME, '')
#chdir to Unknown Horizons root
os.chdir( find_uh_position() )
logging.config.fileConfig( os.path.join('content', 'logging.conf'))
create_user_dirs()
options = get_option_parser().parse_args()[0]
setup_debugging(options)
# NOTE: this might cause a program restart
init_environment()
# test if required libs can be found or display specific error message
try:
import yaml
except ImportError:
headline = _("Error: Unable to find required libraries")
msg = _("We are sorry to inform you that a library that is required by Unknown Horizons, is missing and needs to be installed.") + "\n" + \
_("Installers for Windows users are available at \"http://pyyaml.org/wiki/PyYAML\", Linux users should find it in their packagement management system under the name \"pyyaml\" or \"python-yaml\".")
standalone_error_popup(headline, msg)
exit(1)
#start UH
import horizons.main
ret = True
if not options.profile:
# start normal
ret = horizons.main.start(options)
else:
# start with profiling
try:
import cProfile as profile
except ImportError:
import profile
from horizons.constants import PATHS
profiling_dir = os.path.join(PATHS.USER_DIR, 'profiling')
if not os.path.exists(profiling_dir):
os.makedirs(profiling_dir)
outfilename = os.path.join(profiling_dir, time.strftime('%Y-%m-%d_%H-%M-%S') + '.prof')
print('Starting in profile mode. Writing output to: %s' % outfilename)
profile.runctx('horizons.main.start(options)', globals(), locals(), outfilename)
print('Program ended. Profiling output: %s' % outfilename)
if logfile:
logfile.close()
if ret:
print(_('Thank you for using Unknown Horizons!'))
def setup_debugging(options):
"""Parses and applies options
@param options: parameters: debug, debug_module, debug_log_only, logfile
"""
global logfilename, logfile
# not too nice way of sharing code, but it is necessary because code from this file
# can't be accessed elsewhere on every distribution, and we can't just access other code.
# however passing options is guaranteed to work
options.setup_debugging = setup_debugging
# apply options
if options.debug or options.debug_log_only:
logging.getLogger().setLevel(logging.DEBUG)
for module in options.debug_module:
if not module in logging.Logger.manager.loggerDict:
print('No such logger: %s' % module)
sys.exit(1)
logging.getLogger(module).setLevel(logging.DEBUG)
if options.debug or len(options.debug_module) > 0 or options.debug_log_only:
options.debug = True
# also log to file
# init a logfile handler with a dynamic filename
from horizons.constants import PATHS
if options.logfile:
logfilename = options.logfile
else:
logfilename = os.path.join(PATHS.LOG_DIR, "unknown-horizons-%s.log" % \
time.strftime("%Y-%m-%d_%H-%M-%S"))
print('Logging to %s' % logfilename.encode('utf-8', 'replace'))
# create logfile
logfile = open(logfilename, 'w')
# log there
file_handler = logging.FileHandler(logfilename, 'a')
logging.getLogger().addHandler(file_handler)
# log exceptions
sys.excepthook = excepthook_creator(logfilename)
# log any other stdout output there (this happens, when FIFE c++ code launches some
# FIFE python code and an exception happens there). The exceptionhook only gets
# a director exception, but no real error message then.
class StdOutDuplicator(object):
def write(self, line):
line = unicode(line)
sys.__stdout__.write(line)
logfile.write(line.encode('UTF-8'))
def flush(self):
sys.__stdout__.flush()
logfile.flush()
sys.stdout = StdOutDuplicator()
# add a handler to stderr too _but_ only if logfile isn't already a tty
# this allows --debug-module=<module> --logfile=/dev/stdout
# without getting logs twice + without enabling debug log for everything
# (see first if-clause inside that method)
if not options.debug_log_only and not logfile.isatty():
logging.getLogger().addHandler( logging.StreamHandler(sys.stderr) )
log_sys_info()
"""
Functions controlling the program environment.
NOTE: these are supposed to be in an extra file, but are placed here for simplifying
distribution
"""
def setup_fife(args):
""" Find FIFE and setup search paths, if it can't be imported yet."""
try:
from fife import fife
except ImportError as e:
if '--fife-in-library-path' in args:
# fife should already be in LD_LIBRARY_PATH
log_paths()
err_str = str(e)
if err_str == 'DLL load failed: %1 is not a valid Win32 application.':
show_error_message('Unsupported Python version', '32 bit FIFE requires 32 bit (x86) Python 2.')
else:
show_error_message('Failed to load FIFE', err_str)
log().debug('Failed to load FIFE from default paths: %s', e)
log().debug('Searching for FIFE')
find_FIFE() # this restarts or terminates the program
assert False
log().debug('Using fife: %s', fife)
for arg in ['--fife-in-library-path', '--fife-path']:
if arg in args:
args.remove(arg)
def init_environment():
"""Sets up everything. Use in any program that requires access to FIFE and uh modules.
It will parse sys.args, so this var has to contain only valid uh options."""
# install dummy translation
gettext.install('', unicode=True)
options = get_option_parser().parse_args()[0]
if options.fife_path and not options.fife_in_library_path:
# we got an explicit path, search there
# (but skip on second run, else we've got an endless loop)
find_FIFE(options.fife_path)
#find FIFE and setup search paths, if it can't be imported yet
setup_fife(sys.argv)
def get_fife_path(fife_custom_path=None):
"""Returns absolute path to FIFE engine. Calls sys.exit() if it can't be found."""
# assemble a list of paths where FIFE could be located at
_paths = []
# check if there is a config file (has to be called config.py)
# first check for commandline arg
if fife_custom_path is not None:
_paths.append(fife_custom_path)
if not check_path_for_fife(fife_custom_path):
print('Specified invalid FIFE path: %s' % fife_custom_path)
exit(1)
else:
# no command line parameter, now check for config
try:
import config
_paths.append(config.fife_path)
if not check_path_for_fife(config.fife_path):
print('Invalid fife_path in config.py: %s' % config.fife_path)
exit(1)
except (ImportError, AttributeError):
# no config, try frequently used paths
_paths += [ os.path.join(a, b, c) for \
a in ('.', '..', '../..') for \
b in ('.', 'fife', 'FIFE', 'Fife') for \
c in ('.', 'trunk') ]
fife_path = None
for p in _paths:
if p not in sys.path: # skip dirs where import would have found FIFE
p = os.path.abspath(p)
log().debug("Searching for FIFE in %s", p)
if check_path_for_fife(p):
fife_path = p
log().debug("Found FIFE in %s", fife_path)
#add python paths (<fife>/engine/extensions <fife>/engine/swigwrappers/python)
pythonpaths = [ os.path.join( fife_path, 'engine/python') ]
for path in pythonpaths:
if os.path.exists(path):
sys.path.append(path)
if 'PYTHONPATH' in os.environ:
os.environ['PYTHONPATH'] += os.path.pathsep + path
else:
os.environ['PYTHONPATH'] = path
#add windows paths (<fife>/.)
if 'PATH' in os.environ:
os.environ['PATH'] += os.path.pathsep + fife_path
else:
os.environ['PATH'] = fife_path
os.path.defpath += os.path.pathsep + fife_path
break
else:
print(_('FIFE was not found.'))
sys.exit(1)
return fife_path
def check_path_for_fife(path):
"""Checks if typical FIFE directories exist in path. This does not guarantee, that it's
really a FIFE dir, but it generally works."""
absolute_path = os.path.abspath(path)
for pe in [ os.path.join(absolute_path, a) for a in ('.', 'engine', 'engine/python/fife', \
'engine/python/fife/extensions') ]:
if not os.path.exists(pe):
return False
return True
def find_FIFE(fife_custom_path=None):
"""Inserts path to FIFE engine to $LD_LIBRARY_PATH (environment variable).
If it's already there, the function will return, else
it will restart uh with correct $LD_LIBRARY_PATH. """
global logfilename
fife_path = get_fife_path(fife_custom_path) # terminates program if FIFE can't be found
os.environ['LD_LIBRARY_PATH'] = os.path.pathsep.join( \
[ os.path.abspath(fife_path + '/' + a) for \
a in ('ext/minizip', 'ext/install/lib') ] + \
(os.environ['LD_LIBRARY_PATH'].split(os.path.pathsep) if \
os.environ.has_key('LD_LIBRARY_PATH') else []))
log().debug("Restarting with proper LD_LIBRARY_PATH...")
log_paths()
# assemble args (python run_uh.py ..)
args = [sys.executable] + sys.argv + [ "--fife-in-library-path" ]
# WORKAROUND: windows systems don't handle spaces in arguments for execvp correctly.
if platform.system() != 'Windows':
if logfilename:
args += [ "--logfile", logfilename ]
log().debug("Restarting with args %s", args)
os.execvp(args[0], args)
else:
args[1] = "\"%s\"" % args[1]
args += [ "--logfile", "\"%s\"" % logfilename ]
log().debug("Restarting using windows workaround with args %s", args)
os.system(" ".join(args))
sys.exit(0)
def log_paths():
"""Prints debug info about paths to log"""
log().debug("SYS.PATH: %s", sys.path)
log().debug("PATHSEP: \"%s\" SEP: \"%s\"", os.path.pathsep, os.path.sep)
log().debug("LD_LIBRARY_PATH: %s", os.environ['LD_LIBRARY_PATH'])
log().debug("PATH: %s", os.environ['PATH'])
log().debug("PYTHONPATH %s", os.environ.get('PYTHONPATH', '<undefined>'))
def log_sys_info():
"""Prints debug info about the current system to log"""
log().debug("Python version: %s", sys.version_info)
log().debug("Plattform: %s", platform.platform())
def standalone_error_popup(headline, msg):
"""Display an error via gui.
Use only for errors that make 'import horizons.main' fail."""
from fife.extensions import pychan
from fife import fife
e = fife.Engine()
e.getSettings().setDefaultFontPath("content/fonts/LinLibertine.ttf")
e.init()
pychan.init(e)
pychan.loadFonts("content/fonts/libertine.fontdef")
# hack for accessing this in do_quit (global does't work as the variables here are local)
class Quit(object):
do = False
def do_quit():
Quit.do=True
dlg = pychan.loadXML("content/gui/xml/startup_error_popup.xml")
# can't translate as translations are only set up later
dlg.findChild(name="headline").text = headline
dlg.findChild(name="msg").text = msg
dlg.mapEvents({'quit_button': do_quit})
dlg.show()
e.initializePumping()
while not Quit.do:
e.pump()
e.finalizePumping()
if __name__ == '__main__':
main()