livie
/
phoenix-firestorm
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
phoenix-firestorm/indra/newview/viewer_manifest.py

2264 lines
108 KiB
Python
Executable File
Raw Permalink Blame History

#!/usr/bin/env python3
"""\
@file viewer_manifest.py
@author Ryan Williams
@brief Description of all installer viewer files, and methods for packaging
them into installers for all supported platforms.
$LicenseInfo:firstyear=2006&license=viewerlgpl$
Second Life Viewer Source Code
Copyright (C) 2006-2014, Linden Research, Inc.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation;
version 2.1 of the License only.
This library 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Linden Research, Inc., 945 Battery Street, San Francisco, CA 94111 USA
$/LicenseInfo$
"""
import errno
import glob
import itertools
import json
import os
import os.path
import plistlib
import random
import re
import secrets
import shutil
import subprocess
import sys
import tarfile
import tempfile
import time
sys.dont_write_bytecode = True # <FS:Ansariel> Prevents creating __pycache__ directory
from fs_viewer_manifest import FSViewerManifest #<FS:ND/> Manifest extensions for Firestorm
viewer_dir = os.path.dirname(__file__)
# Add indra/lib/python to our path so we don't have to muck with PYTHONPATH.
# Put it FIRST because some of our build hosts have an ancient install of
# indra.util.llmanifest under their system Python!
sys.path.insert(0, os.path.join(viewer_dir, os.pardir, "lib", "python"))
from indra.util.llmanifest import LLManifest, main, path_ancestors, CHANNEL_VENDOR_BASE, RELEASE_CHANNEL, ManifestError, MissingError
# <FS:Beq> try to work around weird Mac build issue that seems to find the wrong python
#import llsd
try:
import llsd
except ImportError:
from llbase import llsd
# </FS:Beq>
class ViewerManifest(LLManifest,FSViewerManifest):
def is_packaging_viewer(self):
# Some commands, files will only be included
# if we are packaging the viewer on windows.
# This manifest is also used to copy
# files during the build (see copy_w_viewer_manifest
# and copy_l_viewer_manifest targets)
return 'package' in self.args['actions']
def construct(self):
super(ViewerManifest, self).construct()
self.path(src="../../scripts/messages/message_template.msg", dst="app_settings/message_template.msg")
# <FS:LO> Copy dictionaries to a place where the viewer can find them if ran from visual studio
pkgdir = os.path.join(self.args['build'], os.pardir, 'packages')
with self.prefix(src=pkgdir, dst="app_settings"):
self.path("dictionaries")
# <FS:Ansariel> Copy 360 snapshot JavaScripts
with self.prefix(src=pkgdir, dst="skins/default/html/common/equirectangular"):
self.path("js")
# </FS:Ansariel>
# <FS:Ansariel> Copy 3p fonts to build output
with self.prefix(src=pkgdir):
self.path("fonts")
# </FS:Ansariel>
# <FS:Ansariel> Copy emoji characters to build output
with self.prefix(src=pkgdir, dst="skins/default"):
self.path("xui")
# </FS:Ansariel>
if self.is_packaging_viewer():
with self.prefix(src_dst="app_settings"):
self.exclude("logcontrol.xml")
self.exclude("logcontrol-dev.xml")
self.path("*.ini")
self.path("*.xml")
# include the entire shaders directory recursively
self.path("shaders")
# include the extracted list of contributors
contributions_path = os.path.join(self.args['source'], "..", "..", "doc", "contributions.txt")
contributor_names = self.extract_names(contributions_path)
self.put_in_file(contributor_names.encode(), "contributors.txt", src=contributions_path)
# ... and the default camera position settings
self.path("camera")
# ... and the entire windlight directory
self.path("windlight")
# ... and the entire image filters directory
self.path("filters")
# ... and the included spell checking dictionaries
# <FS:LO> Copy dictionaries to a place where the viewer can find them if ran from visual studio
# ... and the included spell checking dictionaries
# pkgdir = os.path.join(self.args['build'], os.pardir, 'packages')
# with self.prefix(src=pkgdir):
# self.path("dictionaries")
# </FS:LO>
# include the entire beams directory
self.path("beams")
self.path("beamsColors")
# <FS:AR> Poser Presets
self.path("poses")
# <FS:Beq> package static_assets folder
if self.fs_is_opensim():
self.path("static_assets")
self.path("fs_static_assets")
# </FS:Beq>
# include the extracted packages information (see BuildPackagesInfo.cmake)
self.path(src=os.path.join(self.args['build'],"packages-info.txt"), dst="packages-info.txt")
# CHOP-955: If we have "sourceid" or "viewer_channel" in the
# build process environment, generate it into
# settings_install.xml.
settings_template = dict(
sourceid=dict(Comment='Identify referring agency to Linden web servers',
Persist=1,
Type='String',
Value=''),
CmdLineGridChoice=dict(Comment='Default grid',
Persist=0,
Type='String',
Value=''),
CmdLineChannel=dict(Comment='Command line specified channel name',
Persist=0,
Type='String',
Value=''))
settings_install = {}
sourceid = self.args.get('sourceid')
if sourceid:
settings_install['sourceid'] = settings_template['sourceid'].copy()
settings_install['sourceid']['Value'] = sourceid
print("Set sourceid in settings_install.xml to '%s'" % sourceid)
if self.args.get('channel_suffix'):
settings_install['CmdLineChannel'] = settings_template['CmdLineChannel'].copy()
settings_install['CmdLineChannel']['Value'] = self.channel_with_pkg_suffix()
print("Set CmdLineChannel in settings_install.xml to '%s'" % self.channel_with_pkg_suffix())
if self.args.get('grid'):
settings_install['CmdLineGridChoice'] = settings_template['CmdLineGridChoice'].copy()
settings_install['CmdLineGridChoice']['Value'] = self.grid()
print("Set CmdLineGridChoice in settings_install.xml to '%s'" % self.grid())
# put_in_file(src=) need not be an actual pathname; it
# only needs to be non-empty
self.put_in_file(llsd.format_pretty_xml(settings_install),
"settings_install.xml",
src="environment")
with self.prefix(src_dst="character"):
self.path("*.llm")
self.path("*.xml")
self.path("*.tga")
# Include our fonts
# <FS:Ansariel> Don't copy fonts to the source folder
#with self.prefix(src="../packages/fonts",src_dst="fonts"):
with self.prefix(src_dst="fonts"):
# </FS:Ansariel>
self.path("*.ttf")
self.path("*.txt")
self.path("*.xml")
# <FS:AO> Include firestorm resources
with self.prefix(src_dst="fs_resources"):
self.path("*.lsltxt")
self.path("*.dae") # <FS:Beq> FIRE-30963 - better physics defaults
# skins
with self.prefix(src_dst="skins"):
self.path("skins.xml")
# include the entire textures directory recursively
with self.prefix(src_dst="*/textures"):
self.path("*/*.jpg") # <FS:TJ> Needed for Firestorm skins
self.path("*/*.tga") # <FS:Ansariel> Needed for legacy icons
self.path("*/*.png")
self.path("*.tga")
self.path("*.j2c")
self.path("*.jpg") # <FS:Ansariel> Needed for Firestorm
self.path("*.png")
self.path("textures.xml")
self.path("*/xui/*/*.xml")
self.path("*/xui/*/widgets/*.xml")
self.path("*/themes/*/colors.xml")
with self.prefix(src_dst="*/themes/*/textures"):
self.path("*/*.tga")
self.path("*/*.jpg")
self.path("*/*.png")
self.path("*.tga")
self.path("*.j2c")
self.path("*.png")
self.path("*/*.xml")
# Update: 2017-11-01 CP Now we store app code in the html folder
# Initially the HTML/JS code to render equirectangular
# images for the 360 capture feature but more to follow.
with self.prefix(src="*/html", dst="*/html"):
#self.path("*/*/*/*.js") # <FS:Ansariel> Copied outside packaging and from packages directory already
self.path("*/*/*.html")
#build_data.json. Standard with exception handling is fine. If we can't open a new file for writing, we have worse problems
#platform is computed above with other arg parsing
build_data_dict = {"Type":"viewer","Version":'.'.join(self.args['version']),
"Channel Base": CHANNEL_VENDOR_BASE,
"Channel":self.channel_with_pkg_suffix(),
"Platform":self.build_data_json_platform,
"Address Size":self.address_size,
"Update Service":"https://update.secondlife.com/update",
}
# Only store this if it's both present and non-empty
bugsplat_db = self.args.get('bugsplat')
if bugsplat_db:
build_data_dict["BugSplat DB"] = bugsplat_db
build_data_dict = self.finish_build_data_dict(build_data_dict)
with open(os.path.join(os.pardir,'build_data.json'), 'w') as build_data_handle:
json.dump(build_data_dict,build_data_handle)
#we likely no longer need the test, since we will throw an exception above, but belt and suspenders and we get the
#return code for free.
if not self.path2basename(os.pardir, "build_data.json"):
print("No build_data.json file")
def finish_build_data_dict(self, build_data_dict):
return build_data_dict
def grid(self):
return self.args['grid']
def channel(self):
return self.args['channel']
def channel_with_pkg_suffix(self):
fullchannel=self.channel()
channel_suffix = self.args.get('channel_suffix')
if channel_suffix:
fullchannel+=' '+channel_suffix
return fullchannel
def channel_variant(self):
global CHANNEL_VENDOR_BASE
return self.channel().replace(CHANNEL_VENDOR_BASE, "").strip()
def channel_type(self): # returns 'release', 'beta', 'project', or 'test'
channel_qualifier=self.channel_variant().lower()
#<FS:TS> Somehow, we started leaving the - separating the variant from the app name
# on the beginning of the channel qualifier. This screws up later processing that
# depends on the channel type. If it's there, we chop it off.
if channel_qualifier[0] == '-':
channel_qualifier = channel_qualifier[1:]
if channel_qualifier.startswith('release'):
channel_type='release'
elif channel_qualifier.startswith('beta'):
channel_type='beta'
elif channel_qualifier.startswith('alpha'):
channel_type='alpha'
#<FS:TS> Use our more-or-less-standard channel types instead of LL's
#elif channel_qualifier.startswith('project'):
# channel_type='project'
#else:
# channel_type='test'
elif channel_qualifier.startswith('nightly'):
channel_type='nightly'
elif channel_qualifier.startswith('manual'):
channel_type='manual'
elif channel_qualifier.startswith('profiling'):
channel_type='profiling'
else:
channel_type='private'
return channel_type
def channel_variant_app_suffix(self):
# get any part of the channel name after the CHANNEL_VENDOR_BASE
suffix=self.channel_variant()
# by ancient convention, we don't use Release in the app name
#<FS:TS> Well, LL doesn't, but we do. Don't remove it.
#if self.channel_type() == 'release':
# suffix=suffix.replace('Release', '').strip()
# for the base release viewer, suffix will now be null - for any other, append what remains
if suffix:
#suffix = "_".join([''] + suffix.split())
suffix = "_".join(suffix.split()) # <FS> Don't prepend underscore before suffix
# the additional_packages mechanism adds more to the installer name (but not to the app name itself)
# ''.split() produces empty list, so suffix only changes if
# channel_suffix is non-empty
suffix = "_".join([suffix] + self.args.get('channel_suffix', '').split())
return suffix
def installer_base_name(self):
global CHANNEL_VENDOR_BASE
# a standard map of strings for replacing in the templates
#<FS:TS> tag "OS" after CHANNEL_VENDOR_BASE and before any suffix
channel_base = "Phoenix-" + CHANNEL_VENDOR_BASE
if self.fs_is_opensim():
channel_base = channel_base + "OS"
#</FS:TS>
substitution_strings = {
'channel_vendor_base' : '_'.join(channel_base.split()),
'channel_variant_underscores':self.channel_variant_app_suffix(),
'version_underscores' : '_'.join(self.args['version']),
'arch':self.args['arch']
}
return "%(channel_vendor_base)s%(channel_variant_underscores)s_%(version_underscores)s_%(arch)s" % substitution_strings
def installer_base_name_mac(self):
global CHANNEL_VENDOR_BASE
# a standard map of strings for replacing in the templates
substitution_strings = {
'channel_vendor_base' : '_'.join(CHANNEL_VENDOR_BASE.split()),
'channel_variant_underscores':self.channel_variant_app_suffix(),
'version_underscores' : '_'.join(self.args['version'])
}
return "%(channel_vendor_base)s%(channel_variant_underscores)s_%(version_underscores)s_universal" % substitution_strings
def app_name(self):
global CHANNEL_VENDOR_BASE
channel_type=self.channel_type()
#<FS:TS> LL uses "Viewer" in the name of their release package. We use "Release".
#if channel_type == 'release':
# app_suffix='Viewer'
#else:
# app_suffix=self.channel_variant()
app_suffix=self.channel_variant()
#<FS:ND> tag "OS" after CHANNEL_VENDOR_BASE and before any suffix
if self.fs_is_opensim():
app_suffix = "OS" + app_suffix
#</FS:ND>
#<FS:ND> Don't separate name by whitespace. This break a lot of things in the old FS installer logic.
#return CHANNEL_VENDOR_BASE + ' ' + app_suffix
return CHANNEL_VENDOR_BASE + app_suffix
#</FS:ND>
def exec_name(self):
# <FS:Ansariel> Same as app_name_oneword()
#return "SecondLifeViewer"
return ''.join(self.app_name().split())
def app_name_oneword(self):
return ''.join(self.app_name().split())
# <FS:Ansariel> FIRE-30446: Set FriendlyAppName for protocol registrations
def friendly_app_name(self):
global CHANNEL_VENDOR_BASE
return CHANNEL_VENDOR_BASE
# </FS:Ansariel>
def icon_path(self):
# <FS:ND> Add -os for oss builds
chan = self.channel_type()
if chan in ['alpha', 'nightly','manual', 'profiling']:
chan = 'test'
if self.fs_is_opensim():
return "icons/" + chan + "-os"
# </FS:ND>
return "icons/" + chan
def extract_names(self,src):
"""Extract contributor names from source file, returns string"""
try:
with open(src, 'r') as contrib_file:
lines = contrib_file.readlines()
except IOError:
print("Failed to open '%s'" % src)
raise
# All lines up to and including the first blank line are the file header; skip them
lines.reverse() # so that pop will pull from first to last line
while not re.match(r"\s*$", lines.pop()) :
pass # do nothing
# A line that starts with a non-whitespace character is a name; all others describe contributions, so collect the names
names = []
for line in lines :
if re.match(r"\S", line) :
names.append(line.rstrip())
# It's not fair to always put the same people at the head of the list
random.shuffle(names)
return ', '.join(names)
def relsymlinkf(self, src, dst=None, catch=True):
"""
relsymlinkf() is just like symlinkf(), but instead of requiring the
caller to pass 'src' as a relative pathname, this method expects 'src'
to be absolute, and creates a symlink whose target is the relative
path from 'src' to dirname(dst).
"""
dstdir, dst = self._symlinkf_prep_dst(src, dst)
# Determine the relative path starting from the directory containing
# dst to the intended src.
src = self.relpath(src, dstdir)
self._symlinkf(src, dst, catch)
return dst
def symlinkf(self, src, dst=None, catch=True):
"""
Like ln -sf, but uses os.symlink() instead of running ln. This creates
a symlink at 'dst' that points to 'src' -- see:
https://docs.python.org/3/library/os.html#os.symlink
If you omit 'dst', this creates a symlink with basename(src) at
get_dst_prefix() -- in other words: put a symlink to this pathname
here at the current dst prefix.
'src' must specifically be a *relative* symlink. It makes no sense to
create an absolute symlink pointing to some path on the build machine!
Also:
- We prepend 'dst' with the current get_dst_prefix(), so it has similar
meaning to associated self.path() calls.
- We ensure that the containing directory os.path.dirname(dst) exists
before attempting the symlink.
If you pass catch=False, exceptions will be propagated instead of
caught.
"""
dstdir, dst = self._symlinkf_prep_dst(src, dst)
self._symlinkf(src, dst, catch)
return dst
def _symlinkf_prep_dst(self, src, dst):
# helper for relsymlinkf() and symlinkf()
if dst is None:
dst = os.path.basename(src)
dst = os.path.join(self.get_dst_prefix(), dst)
# Seems silly to prepend get_dst_prefix() to dst only to call
# os.path.dirname() on it again, but this works even when the passed
# 'dst' is itself a pathname.
dstdir = os.path.dirname(dst)
self.cmakedirs(dstdir)
return (dstdir, dst)
def _symlinkf(self, src, dst, catch):
# helper for relsymlinkf() and symlinkf()
# the passed src must be relative
if os.path.isabs(src):
raise ManifestError("Do not symlinkf(absolute %r, asis=True)" % src)
# The outer catch is the one that reports failure even after attempted
# recovery.
try:
# At the inner layer, recovery may be possible.
try:
os.symlink(src, dst)
except OSError as err:
if err.errno != errno.EEXIST:
raise
# We could just blithely attempt to remove and recreate the target
# file, but that strategy doesn't work so well if we don't have
# permissions to remove it. Check to see if it's already the
# symlink we want, which is the usual reason for EEXIST.
elif os.path.islink(dst):
if os.readlink(dst) == src:
# the requested link already exists
pass
else:
# dst is the wrong symlink; attempt to remove and recreate it
os.remove(dst)
os.symlink(src, dst)
elif os.path.isdir(dst):
print("Requested symlink (%s) exists but is a directory; replacing" % dst)
shutil.rmtree(dst)
os.symlink(src, dst)
elif os.path.exists(dst):
print("Requested symlink (%s) exists but is a file; replacing" % dst)
os.remove(dst)
os.symlink(src, dst)
else:
# out of ideas
raise
except Exception as err:
# report
print("Can't symlink %r -> %r: %s: %s" % \
(dst, src, err.__class__.__name__, err))
# if caller asked us not to catch, re-raise this exception
if not catch:
raise
def relpath(self, path, base=None, symlink=False):
"""
Return the relative path from 'base' to the passed 'path'. If base is
omitted, self.get_dst_prefix() is assumed. In other words: make a
same-name symlink to this path right here in the current dest prefix.
Normally we resolve symlinks. To retain symlinks, pass symlink=True.
"""
if base is None:
base = self.get_dst_prefix()
# Since we use os.path.relpath() for this, which is purely textual, we
# must ensure that both pathnames are absolute.
if symlink:
# symlink=True means: we know path is (or indirects through) a
# symlink, don't resolve, we want to use the symlink.
abspath = os.path.abspath
else:
# symlink=False means to resolve any symlinks we may find
abspath = os.path.realpath
return os.path.relpath(abspath(path), abspath(base))
# <FS:Ansariel> Undo Github-Build stuff - I don't think we need this
#def set_github_output_path(self, variable, path):
# self.set_github_output(variable,
# os.path.normpath(os.path.join(self.get_dst_prefix(), path)))
#def set_github_output(self, variable, *values):
# GITHUB_OUTPUT = os.getenv('GITHUB_OUTPUT')
# if GITHUB_OUTPUT and values:
# with open(GITHUB_OUTPUT, 'a') as outf:
# if len(values) == 1:
# print('='.join((variable, values[0])), file=outf)
# else:
# delim = secrets.token_hex(8)
# print('<<'.join((variable, delim)), file=outf)
# for value in values:
# print(value, file=outf)
# print(delim, file=outf)
# </FS:Ansariel>
class Windows_x86_64_Manifest(ViewerManifest):
# We want the platform, per se, for every Windows build to be 'win'. The
# VMP will concatenate that with the address_size.
build_data_json_platform = 'win'
address_size = 64
def final_exe(self):
return self.exec_name()+".exe"
def finish_build_data_dict(self, build_data_dict):
build_data_dict['Executable'] = self.final_exe()
build_data_dict['AppName'] = self.app_name()
return build_data_dict
def test_msvcrt_and_copy_action(self, src, dst):
# This is used to test a dll manifest.
# It is used as a temporary override during the construct method
from test_win32_manifest import test_assembly_binding
# TODO: This is redundant with LLManifest.copy_action(). Why aren't we
# calling copy_action() in conjunction with test_assembly_binding()?
if src and (os.path.exists(src) or os.path.islink(src)):
# ensure that destination path exists
self.cmakedirs(os.path.dirname(dst))
self.created_paths.append(dst)
if not os.path.isdir(src):
if(self.args['buildtype'].lower() == 'debug'):
test_assembly_binding(src, "Microsoft.VC80.DebugCRT", "8.0.50727.4053")
else:
test_assembly_binding(src, "Microsoft.VC80.CRT", "8.0.50727.4053")
self.ccopy(src,dst)
else:
raise Exception("Directories are not supported by test_CRT_and_copy_action()")
else:
print("Doesn't exist:", src)
def test_for_no_msvcrt_manifest_and_copy_action(self, src, dst):
# This is used to test that no manifest for the msvcrt exists.
# It is used as a temporary override during the construct method
from test_win32_manifest import test_assembly_binding
from test_win32_manifest import NoManifestException, NoMatchingAssemblyException
# TODO: This is redundant with LLManifest.copy_action(). Why aren't we
# calling copy_action() in conjunction with test_assembly_binding()?
if src and (os.path.exists(src) or os.path.islink(src)):
# ensure that destination path exists
self.cmakedirs(os.path.dirname(dst))
self.created_paths.append(dst)
if not os.path.isdir(src):
try:
if(self.args['buildtype'].lower() == 'debug'):
test_assembly_binding(src, "Microsoft.VC80.DebugCRT", "")
else:
test_assembly_binding(src, "Microsoft.VC80.CRT", "")
raise Exception("Unknown condition")
except NoManifestException as err:
pass
except NoMatchingAssemblyException as err:
pass
self.ccopy(src,dst)
else:
raise Exception("Directories are not supported by test_CRT_and_copy_action()")
else:
print("Doesn't exist:", src)
def construct(self):
super().construct()
pkgdir = os.path.join(self.args['build'], os.pardir, 'packages')
relpkgdir = os.path.join(pkgdir, "lib", "release")
debpkgdir = os.path.join(pkgdir, "lib", "debug")
if self.is_packaging_viewer():
# Find firestorm-bin.exe in the 'configuration' dir, then rename it to the result of final_exe.
self.path(src='%s/firestorm-bin.exe' % self.args['configuration'], dst=self.final_exe())
# Emit the whole app image as one of the GitHub step outputs. We
# want the whole app -- but NOT the extraneous build products that
# get tossed into the same directory, such as the installer and
# the symbols tarball, so add exclusions. When we feed
# upload-artifact multiple absolute pathnames, even just for
# exclusion, it ends up creating several extraneous directory
# levels within the artifact -- so try using only relative paths.
# One problem: as of right now, our current directory os.getcwd()
# is not the same as the initial working directory for this job
# step, meaning paths relative to our os.getcwd() won't work for
# the subsequent upload-artifact step. We're a couple directory
# levels down. Try adjusting for those when specifying the base
# for self.relpath().
# <FS:Ansariel> Undo Github-Build stuff - I don't think we need this
#appbase = self.relpath(
# self.get_dst_prefix(),
# base=os.path.join(os.getcwd(), os.pardir, os.pardir))
#self.set_github_output('viewer_app', appbase,
# # except for this stuff
# *(('!' + os.path.join(appbase, pattern))
# for pattern in (
# 'secondlife-bin.*',
# '*_Setup.exe',
# '*.bat',
# '*.tar.xz')))
# </FS:Ansariel>
# <FS:Ansariel> Remove VMP
#with self.prefix(src=os.path.join(pkgdir, "VMP")):
# include the compiled launcher scripts so that it gets included in the file_list
# self.path('SLVersionChecker.exe')
#with self.prefix(dst="vmp_icons"):
# with self.prefix(src=self.icon_path()):
# self.path("secondlife.ico")
#VMP Tkinter icons
# with self.prefix(src="vmp_icons"):
# self.path("*.png")
# self.path("*.gif")
# </FS:Ansariel> Remove VMP
# Plugin host application
self.path2basename(os.path.join(os.pardir,
'llplugin', 'slplugin', self.args['configuration']),
"slplugin.exe")
# Get shared libs from the shared libs staging directory
with self.prefix(src=os.path.join(self.args['build'], os.pardir,
'sharedlibs', self.args['buildtype'])):
# WebRTC libraries
for libfile in (
'llwebrtc.dll',
):
self.path(libfile)
if self.args['discord'] == 'ON':
self.path("discord_partner_sdk.dll")
# Mesh 3rd party libs needed for auto LOD and collada reading
try:
self.path("glod.dll")
except RuntimeError as err:
print (err.message)
print ("Skipping GLOD library (assumming linked statically)")
# Get fmodstudio dll if needed
# if self.args['fmodstudio'] == 'ON':
if self.args['fmodstudio'].lower() == 'on':
if(self.args['buildtype'].lower() == 'debug'):
self.path("fmodL.dll")
else:
self.path("fmod.dll")
# if self.args['openal'] == 'ON':
if self.args['openal'].lower() == 'on':
# Get openal dll
self.path("OpenAL32.dll")
self.path("alut.dll")
# For textures
self.path_optional("openjp2.dll")
# These need to be installed as a SxS assembly, currently a 'private' assembly.
# See http://msdn.microsoft.com/en-us/library/ms235291(VS.80).aspx
self.path("msvcp140.dll")
self.path_optional("msvcp140_1.dll")
self.path_optional("msvcp140_2.dll")
self.path_optional("msvcp140_atomic_wait.dll")
self.path_optional("msvcp140_codecvt_ids.dll")
self.path("vcruntime140.dll")
self.path_optional("vcruntime140_1.dll")
self.path_optional("vcruntime140_threads.dll")
# SLVoice executable
with self.prefix(src=os.path.join(pkgdir, 'bin', 'release')):
self.path("SLVoice.exe")
# Vivox libraries
self.path("vivoxsdk_x64.dll")
self.path("ortp_x64.dll")
# BugSplat
if self.args.get('bugsplat'):
self.path("BsSndRpt64.exe")
self.path("BugSplat64.dll")
self.path("BugSplatRc64.dll")
if self.args['tracy'] == 'ON':
with self.prefix(src=os.path.join(pkgdir, 'bin')):
self.path("tracy-profiler.exe")
# Growl
self.path("growl.dll")
self.path("growl++.dll")
# <FS:ND> Copy symbols for breakpad
#self.path("ssleay32.pdb")
#self.path("libeay32.pdb")
#self.path("growl.pdb")
#self.path("growl++.pdb")
#self.path('apr-1.pdb', 'libarp.pdb')
#self.path('aprutil-1.pdb', 'libaprutil.pdb')
# </FS:ND>
self.path(src="licenses-win32.txt", dst="licenses.txt")
self.path("featuretable.txt")
self.path("cube.dae")
with self.prefix(src=pkgdir):
self.path("ca-bundle.crt")
self.path("VivoxAUP.txt")
# Media plugins - CEF
with self.prefix(dst="llplugin"):
with self.prefix(src=os.path.join(self.args['build'], os.pardir, 'media_plugins')):
with self.prefix(src=os.path.join('cef', self.args['configuration'])):
self.path("media_plugin_cef.dll")
# Media plugins - LibVLC
with self.prefix(src=os.path.join('libvlc', self.args['configuration'])):
self.path("media_plugin_libvlc.dll")
# Media plugins - Example (useful for debugging - not shipped with release viewer)
# <FS:Ansariel> Don't package example plugin
#if self.channel_type() != 'release':
# with self.prefix(src=os.path.join('example', self.args['configuration'])):
# self.path("media_plugin_example.dll")
# CEF runtime files - debug
# CEF runtime files - not debug (release, relwithdebinfo etc.)
config = 'debug' if self.args['configuration'].lower() == 'debug' else 'release'
with self.prefix(src=os.path.join(pkgdir, 'bin', config)):
self.path("chrome_elf.dll")
self.path("d3dcompiler_47.dll")
self.path("dxcompiler.dll")
self.path("dxil.dll")
self.path("libcef.dll")
self.path("libEGL.dll")
self.path("libGLESv2.dll")
self.path("v8_context_snapshot.bin")
self.path("vk_swiftshader.dll")
self.path("vk_swiftshader_icd.json")
self.path("vulkan-1.dll")
self.path("dullahan_host.exe")
# MSVC DLLs needed for CEF and have to be in same directory as plugin
with self.prefix(src=os.path.join(self.args['build'], os.pardir,
'sharedlibs', self.args['buildtype'])):
self.path("msvcp140.dll")
self.path("vcruntime140.dll")
self.path_optional("vcruntime140_1.dll")
# CEF files common to all configurations
with self.prefix(src=os.path.join(pkgdir, 'resources')):
self.path("chrome_100_percent.pak")
self.path("chrome_200_percent.pak")
self.path("resources.pak")
self.path("icudtl.dat")
with self.prefix(src=os.path.join(pkgdir, 'resources', 'locales'), dst='locales'):
self.path("am.pak")
self.path("ar.pak")
self.path("bg.pak")
self.path("bn.pak")
self.path("ca.pak")
self.path("cs.pak")
self.path("da.pak")
self.path("de.pak")
self.path("el.pak")
self.path("en-GB.pak")
self.path("en-US.pak")
self.path("es-419.pak")
self.path("es.pak")
self.path("et.pak")
self.path("fa.pak")
self.path("fi.pak")
self.path("fil.pak")
self.path("fr.pak")
self.path("gu.pak")
self.path("he.pak")
self.path("hi.pak")
self.path("hr.pak")
self.path("hu.pak")
self.path("id.pak")
self.path("it.pak")
self.path("ja.pak")
self.path("kn.pak")
self.path("ko.pak")
self.path("lt.pak")
self.path("lv.pak")
self.path("ml.pak")
self.path("mr.pak")
self.path("ms.pak")
self.path("nb.pak")
self.path("nl.pak")
self.path("pl.pak")
self.path("pt-BR.pak")
self.path("pt-PT.pak")
self.path("ro.pak")
self.path("ru.pak")
self.path("sk.pak")
self.path("sl.pak")
self.path("sr.pak")
self.path("sv.pak")
self.path("sw.pak")
self.path("ta.pak")
self.path("te.pak")
self.path("th.pak")
self.path("tr.pak")
self.path("uk.pak")
self.path("vi.pak")
self.path("zh-CN.pak")
self.path("zh-TW.pak")
with self.prefix(src=os.path.join(pkgdir, 'bin', 'release')):
self.path("libvlc.dll")
self.path("libvlccore.dll")
self.path("plugins/")
if not self.is_packaging_viewer():
self.package_file = "copied_deps"
self.fs_copy_windows_manifest( )
def nsi_file_commands(self, install=True):
# <FS:Ansariel> Undo Github-Build stuff - I don't think we need this
#def INSTDIR(path):
# # Note that '$INSTDIR' is purely textual here: we write
# # exactly that into the .nsi file for NSIS to interpret.
# # Pass the result through normpath() to handle the case in which
# # path is the empty string. On Windows, that produces "$INSTDIR\".
# # Unfortunately, if that's the last item on a line, NSIS takes
# # that as line continuation and misinterprets the following line.
# # Ensure we don't emit a trailing backslash.
# return os.path.normpath(os.path.join('$INSTDIR', path))
#result = []
#dest_files = [pair[1] for pair in self.file_list if pair[0] and os.path.isfile(pair[1])]
## sort deepest hierarchy first
#dest_files.sort(key=lambda f: (f.count(os.path.sep), f), reverse=True)
#out_path = None
#for pkg_file in dest_files:
# pkg_file = os.path.normpath(pkg_file)
# rel_file = self.relpath(pkg_file)
# installed_dir = INSTDIR(os.path.dirname(rel_file))
# if install and installed_dir != out_path:
# out_path = installed_dir
# # emit SetOutPath every time it changes
# result.append('SetOutPath ' + out_path)
# if install:
# result.append('File ' + rel_file)
# else:
# result.append('Delete ' + INSTDIR(rel_file))
## at the end of a delete, just rmdir all the directories
#if not install:
# deleted_file_dirs = [os.path.dirname(self.relpath(f)) for f in dest_files]
# # find all ancestors so that we don't skip any dirs that happened
# # to have no non-dir children
# deleted_dirs = set(itertools.chain.from_iterable(path_ancestors(d)
# for d in deleted_file_dirs))
# # sort deepest hierarchy first
# for d in sorted(deleted_dirs, key=lambda f: (f.count(os.path.sep), f), reverse=True):
# result.append('RMDir ' + INSTDIR(d))
#return '\n'.join(result)
def wpath(path):
if path.endswith('/') or path.endswith(os.path.sep):
path = path[:-1]
path = path.replace('/', '\\')
return path
result = ""
dest_files = [pair[1] for pair in self.file_list if pair[0] and os.path.isfile(pair[1]) and not pair[1].endswith(".pdb") ] #<FS:ND/> Don't include pdb files.
# sort deepest hierarchy first
dest_files.sort(key=lambda f: (f.count(os.path.sep), f), reverse=True)
out_path = None
for pkg_file in dest_files:
rel_file = os.path.normpath(pkg_file.replace(self.get_dst_prefix()+os.path.sep,''))
installed_dir = wpath(os.path.join('$INSTDIR', os.path.dirname(rel_file)))
pkg_file = wpath(os.path.normpath(pkg_file))
if installed_dir != out_path:
if install:
out_path = installed_dir
result += 'SetOutPath ' + out_path + '\n'
if install:
result += 'File ' + pkg_file + '\n'
else:
result += 'Delete ' + wpath(os.path.join('$INSTDIR', rel_file)) + '\n'
# at the end of a delete, just rmdir all the directories
if not install:
deleted_file_dirs = [os.path.dirname(pair[1].replace(self.get_dst_prefix()+os.path.sep,'')) for pair in self.file_list]
# find all ancestors so that we don't skip any dirs that happened to have no non-dir children
deleted_dirs = []
for d in deleted_file_dirs:
deleted_dirs.extend(path_ancestors(d))
# sort deepest hierarchy first
deleted_dirs.sort(key=lambda f: (f.count(os.path.sep), f), reverse=True)
prev = None
for d in deleted_dirs:
if d != prev: # skip duplicates
result += 'RMDir ' + wpath(os.path.join('$INSTDIR', os.path.normpath(d))) + '\n'
prev = d
return result
# </FS:Ansariel>
def dl_url_from_channel(self):
if self.channel_type() == 'release':
return 'https://www.firestormviewer.org/choose-your-platform'
elif self.channel_type() == 'beta':
return 'https://www.firestormviewer.org/early-access-beta-downloads'
elif self.channel_type() == 'alpha':
return 'https://www.firestormviewer.org/early-access-alpha-downloads'
elif self.channel_type() == 'manual':
return 'https://www.firestormviewer.org/early-access-manual-downloads'
elif self.channel_type() == 'profiling':
return 'https://www.firestormviewer.org/profiling-downloads'
elif self.channel_type() == 'nightly':
return 'https://www.firestormviewer.org/firestorm-nightly-build-downloads'
else:
return '<NO-URL>'
def package_finish(self):
# a standard map of strings for replacing in the templates
substitution_strings = {
'version' : '.'.join(self.args['version']),
'version_short' : '.'.join(self.args['version'][:-1]),
'version_dashes' : '-'.join(self.args['version']),
'version_registry' : '%s(64)' % '.'.join(self.args['version']),
'final_exe' : self.final_exe(),
'flags':'',
'app_name':self.app_name(),
'app_name_oneword':self.app_name_oneword(),
'dl_url':self.dl_url_from_channel()
}
substitution_strings = self.fs_splice_grid_substitution_strings( substitution_strings ) #<FS:ND/> Add grid args
# <FS:ND> Properly name OS version, also add Phoenix- in front of installer name
#installer_file = self.installer_base_name() + '_Setup.exe'
installer_file = self.fs_installer_basename() + "_Setup.exe"
# </FS:ND>
substitution_strings['installer_file'] = installer_file
substitution_strings['is64bit'] = (1 if (self.address_size == 64) else 0)
substitution_strings['isavx2'] = (1 if (self.fs_is_avx2()) else 0)
substitution_strings['is_opensim'] = self.fs_is_opensim() # <FS:Ansariel> FIRE-30446: Register hop-protocol for OS version only
substitution_strings['friendly_app_name'] = self.friendly_app_name() # <FS:Ansariel> FIRE-30446: Set FriendlyAppName for protocol registrations
substitution_strings['icon_suffix'] = ("_os" if (self.fs_is_opensim()) else "") # <FS:Ansariel> FIRE-24335: Use different icon for OpenSim version
version_vars = """
!define INSTEXE "SLVersionChecker.exe"
!define VERSION "%(version_short)s"
!define VERSION_LONG "%(version)s"
!define VERSION_DASHES "%(version_dashes)s"
!define VERSION_REGISTRY "%(version_registry)s"
!define VIEWER_EXE "%(final_exe)s"
""" % substitution_strings
if self.channel_type() == 'release':
substitution_strings['caption'] = CHANNEL_VENDOR_BASE
else:
substitution_strings['caption'] = self.app_name() + ' ${VERSION}'
inst_vars_template = """
OutFile "%(installer_file)s"
!define INSTNAME "%(app_name_oneword)s"
!define SHORTCUT "%(app_name)s"
!define DL_URL "%(dl_url)s"
!define URLNAME "secondlife"
!define IS64BIT "%(is64bit)d"
!define ISAVX2 "%(isavx2)d"
!define ISOPENSIM "%(is_opensim)d"
!define APPNAME "%(friendly_app_name)s"
!define ICON_SUFFIX "%(icon_suffix)s"
Caption "%(caption)s"
"""
engage_registry="SetRegView 64"
program_files="!define MULTIUSER_USE_PROGRAMFILES64"
# Dump the installers/windows directory into the raw app image tree
# because NSIS needs those files. But don't use path() because we
# don't want them installed with the viewer - they're only for use by
# the installer itself.
# <FS:Ansariel> Undo Github-Build stuff - I don't think we need this
#shutil.copytree(os.path.join(self.get_src_prefix(), 'installers', 'windows'),
# os.path.join(self.get_dst_prefix(), 'installers', 'windows'),
# dirs_exist_ok=True)
# </FS:Ansariel>
tempfile = "firestorm_setup_tmp.nsi"
self.fs_sign_win_binaries() # <FS:ND/> Sign files, step one. Sign compiled binaries
# the following replaces strings in the nsi template
# it also does python-style % substitution
self.replace_in("installers/windows/installer_template.nsi", tempfile, {
"%%VERSION%%":version_vars,
# The template references "%%SOURCE%%\installers\windows\...".
# Now that we've copied that directory into the app image
# tree, we can just replace %%SOURCE%% with '.'.
#"%%SOURCE%%":'.', <FS:Ansariel> Undo Github-Build stuff
"%%SOURCE%%":self.get_src_prefix(),
"%%INST_VARS%%":inst_vars_template % substitution_strings,
"%%INSTALL_FILES%%":self.nsi_file_commands(True),
"%%PROGRAMFILES%%":program_files,
"%%ENGAGEREGISTRY%%":engage_registry,
"%%DELETE_FILES%%":self.nsi_file_commands(False)})
# <FS:Ansariel> Undo Github-Build stuff
# Check two paths, one for Program Files, and one for Program Files (x86).
# Yay 64bit windows.
nsis_path = "makensis.exe"
for program_files in '${programfiles}', '${programfiles(x86)}':
for nesis_path in 'NSIS', 'NSIS\\Unicode':
possible_path = os.path.expandvars(f"{program_files}\\{nesis_path}\\makensis.exe")
if os.path.exists(possible_path):
nsis_path = possible_path
break
self.run_command([possible_path, '/V2', self.dst_path_of(tempfile)])
self.fs_sign_win_installer(substitution_strings) # <FS:ND/> Sign files, step two. Sign installer.
self.fs_save_windows_symbols()
self.created_path(self.dst_path_of(installer_file))
self.package_file = installer_file
# </FS:Ansariel>
def sign(self, exe):
sign_py = os.environ.get('SIGN', r'C:\buildscripts\code-signing\sign.py')
python = os.environ.get('PYTHON', sys.executable)
if os.path.exists(sign_py):
dst_path = self.dst_path_of(exe)
print("about to run signing of: ", dst_path)
self.run_command([python, sign_py, dst_path])
else:
print("Skipping code signing of %s %s: %s not found" % (self.dst_path_of(exe), exe, sign_py))
def escape_slashes(self, path):
return path.replace('\\', '\\\\\\\\')
class Darwin_x86_64_Manifest(ViewerManifest):
build_data_json_platform = 'mac'
address_size = 64
def finish_build_data_dict(self, build_data_dict):
build_data_dict.update({'Bundle Id':self.args['bundleid']})
return build_data_dict
def is_packaging_viewer(self):
# darwin requires full app bundle packaging even for debugging.
return True
# <FS:Ansariel> construct method VMP trampoline crazy VMP launcher juggling shamelessly replaced with old version
# def is_rearranging(self):
# # That said, some stuff should still only be performed once.
# # Are either of these actions in 'actions'? Is the set intersection
# # non-empty?
# return bool(set(["package", "unpacked"]).intersection(self.args['actions']))
# def construct(self):
# # copy over the build result (this is a no-op if run within the xcode script)
# self.path(os.path.join(self.args['configuration'], self.channel()+".app"), dst="")
# pkgdir = os.path.join(self.args['build'], os.pardir, 'packages')
# relpkgdir = os.path.join(pkgdir, "lib", "release")
# debpkgdir = os.path.join(pkgdir, "lib", "debug")
# with self.prefix(src="", dst="Contents"): # everything goes in Contents
# bugsplat_db = self.args.get('bugsplat')
# if bugsplat_db:
# # Inject BugsplatServerURL into Info.plist if provided.
# Info_plist = self.dst_path_of("Info.plist")
# Info = plistlib.readPlist(Info_plist)
# # https://www.bugsplat.com/docs/platforms/os-x#configuration
# Info["BugsplatServerURL"] = \
# "https://{}.bugsplat.com/".format(bugsplat_db)
# self.put_in_file(
# plistlib.writePlistToString(Info),
# os.path.basename(Info_plist),
# "Info.plist")
# # CEF framework goes inside Contents/Frameworks.
# # Remember where we parked this car.
# with self.prefix(src=relpkgdir, dst="Frameworks"):
# self.path("libndofdev.dylib")
# if self.args.get('bugsplat'):
# self.path2basename(relpkgdir, "BugsplatMac.framework")
# # OpenAL dylibs
# if self.args['openal'] == 'ON':
# for libfile in (
# "libopenal.dylib",
# "libalut.dylib",
# ):
# self.path(libfile)
# # WebRTC libraries
# with self.prefix(src=os.path.join(self.args['build'], os.pardir,
# 'sharedlibs', self.args['buildtype'], 'Resources')):
# for libfile in (
# 'libllwebrtc.dylib',
# ):
# self.path(libfile)
# with self.prefix(dst="MacOS"):
# executable = self.dst_path_of(self.channel())
# if self.args.get('bugsplat'):
# # According to Apple Technical Note TN2206:
# # https://developer.apple.com/library/archive/technotes/tn2206/_index.html#//apple_ref/doc/uid/DTS40007919-CH1-TNTAG207
# # "If an app uses @rpath or an absolute path to link to a
# # dynamic library outside of the app, the app will be
# # rejected by Gatekeeper. ... Neither the codesign nor the
# # spctl tool will show the error."
# # (Thanks, Apple. Maybe fix spctl to warn?)
# # The BugsplatMac framework embeds @rpath, which is
# # causing scary Gatekeeper popups at viewer start. Work
# # around this by changing the reference baked into our
# # viewer. The install_name_tool -change option needs the
# # previous value. Instead of guessing -- which might
# # silently be defeated by a BugSplat SDK update that
# # changes their baked-in @rpath -- ask for the path
# # stamped into the framework.
# # Let exception, if any, propagate -- if this doesn't
# # work, we need the build to noisily fail!
# oldpath = subprocess.check_output(
# ['objdump', '-macho', '-dylib-id', '-non-verbose',
# os.path.join(relpkgdir, "BugsplatMac.framework", "BugsplatMac")]
# ).splitlines()[-1] # take the last line of output
# self.run_command(
# ['install_name_tool', '-change', oldpath,
# '@executable_path/../Frameworks/BugsplatMac.framework/BugsplatMac',
# executable])
# # NOTE: the -S argument to strip causes it to keep
# # enough info for annotated backtraces (i.e. function
# # names in the crash log). 'strip' with no arguments
# # yields a slightly smaller binary but makes crash
# # logs mostly useless. This may be desirable for the
# # final release. Or not.
# if ("package" in self.args['actions'] or
# "unpacked" in self.args['actions']):
# self.run_command(
# ['strip', '-S', executable])
# with self.prefix(dst="Resources"):
# # defer cross-platform file copies until we're in the
# # nested Resources directory
# super(DarwinManifest, self).construct()
# # need .icns file referenced by Info.plist
# with self.prefix(src=self.icon_path(), dst="") :
# self.path("secondlife.icns")
# # Copy in the updater script and helper modules
# self.path(src=os.path.join(pkgdir, 'VMP'), dst="updater")
# with self.prefix(src="", dst=os.path.join("updater", "icons")):
# self.path2basename(self.icon_path(), "secondlife.ico")
# with self.prefix(src="vmp_icons", dst=""):
# self.path("*.png")
# self.path("*.gif")
# with self.prefix(src_dst="cursors_mac"):
# self.path("*.tif")
# self.path("licenses-mac.txt", dst="licenses.txt")
# self.path("featuretable_mac.txt")
# with self.prefix(src=pkgdir,dst=""):
# self.path("ca-bundle.crt")
# # Translations
# self.path("English.lproj/language.txt")
# self.replace_in(src="English.lproj/InfoPlist.strings",
# dst="English.lproj/InfoPlist.strings",
# searchdict={'%%VERSION%%':'.'.join(self.args['version'])}
# )
# self.path("German.lproj")
# self.path("Japanese.lproj")
# self.path("Korean.lproj")
# self.path("da.lproj")
# self.path("es.lproj")
# self.path("fr.lproj")
# self.path("hu.lproj")
# self.path("it.lproj")
# self.path("nl.lproj")
# self.path("pl.lproj")
# self.path("pt.lproj")
# self.path("ru.lproj")
# self.path("tr.lproj")
# self.path("uk.lproj")
# self.path("zh-Hans.lproj")
# def path_optional(src, dst):
# """
# For a number of our self.path() calls, not only do we want
# to deal with the absence of src, we also want to remember
# which were present. Return either an empty list (absent)
# or a list containing dst (present). Concatenate these
# return values to get a list of all libs that are present.
# """
# # This was simple before we started needing to pass
# # wildcards. Fortunately, self.path() ends up appending a
# # (source, dest) pair to self.file_list for every expanded
# # file processed. Remember its size before the call.
# oldlen = len(self.file_list)
# try:
# self.path(src, dst)
# # The dest appended to self.file_list has been prepended
# # with self.get_dst_prefix(). Strip it off again.
# added = [os.path.relpath(d, self.get_dst_prefix())
# for s, d in self.file_list[oldlen:]]
# except MissingError as err:
# print >> sys.stderr, "Warning: "+err.msg
# added = []
# if not added:
# print "Skipping %s" % dst
# return added
# # dylibs is a list of all the .dylib files we expect to need
# # in our bundled sub-apps. For each of these we'll create a
# # symlink from sub-app/Contents/Resources to the real .dylib.
# # Need to get the llcommon dll from any of the build directories as well.
# libfile_parent = self.get_dst_prefix()
# libfile = "libllcommon.dylib"
# dylibs=[]
# for libfile in (
# "libapr-1.0.dylib",
# "libaprutil-1.0.dylib",
# "libexpat.1.dylib",
# "libGLOD.dylib",
# # libnghttp2.dylib is a symlink to
# # libnghttp2.major.dylib, which is a symlink to
# # libnghttp2.version.dylib. Get all of them.
# "libnghttp2.*dylib",
# ):
# dylibs += path_optional(os.path.join(relpkgdir, libfile), libfile)
# # SLVoice executable
# with self.prefix(src=os.path.join(pkgdir, 'bin', 'release')):
# self.path("SLVoice")
# # Vivox libraries
# for libfile in (
# 'libortp.dylib',
# 'libvivoxsdk.dylib',
# ):
# self.path2basename(relpkgdir, libfile)
# # Fmod studio dylibs (vary based on configuration)
# if self.args['fmodstudio'] == 'ON':
# if self.args['configuration'].lower() == 'debug':
# for libfile in (
# "libfmodL.dylib",
# ):
# dylibs += path_optional(os.path.join(debpkgdir, libfile), libfile)
# else:
# for libfile in (
# "libfmod.dylib",
# ):
# dylibs += path_optional(os.path.join(relpkgdir, libfile), libfile)
# # our apps
# executable_path = {}
# embedded_apps = [ (os.path.join("llplugin", "slplugin"), "SLPlugin.app") ]
# for app_bld_dir, app in embedded_apps:
# self.path2basename(os.path.join(os.pardir,
# app_bld_dir, self.args['configuration']),
# app)
# executable_path[app] = \
# self.dst_path_of(os.path.join(app, "Contents", "MacOS"))
# # Dullahan helper apps go inside SLPlugin.app
# with self.prefix(dst=os.path.join(
# "SLPlugin.app", "Contents", "Frameworks")):
# self.path2basename("../media_plugins/cef/" + self.args['configuration'],
# self.path( "libvlc*.dylib*" )
# # copy LibVLC plugins folder
# self.path( "*.dylib" )
# self.path( "plugins.dat" )
def construct(self):
# copy over the build result (this is a no-op if run within the xcode
# script)
#self.path(os.path.join(self.args['configuration'], self.channel() + ".app"), dst="")
self.path(os.path.join(self.args['configuration'], "Firestorm.app"), dst="")
pkgdir = os.path.join(self.args['build'], os.pardir, 'packages')
relpkgdir = os.path.join(pkgdir, "lib", "release")
debpkgdir = os.path.join(pkgdir, "lib", "debug")
requestsdir = os.path.join(pkgdir, "lib", "python", "requests")
urllib3dir = os.path.join(pkgdir, "lib", "python", "urllib3")
chardetdir = os.path.join(pkgdir, "lib", "python", "chardet")
idnadir = os.path.join(pkgdir, "lib", "python", "idna")
with self.prefix(src="", dst="Contents"): # everything goes in Contents
with self.prefix(dst="MacOS"):
executable = self.dst_path_of("Firestorm") # locate the executable within the bundle.
bugsplat_db = self.args.get('bugsplat')
print(f"debug: bugsplat_db={bugsplat_db}")
if bugsplat_db:
# Inject BugsplatServerURL into Info.plist if provided.
Info_plist = self.dst_path_of("Info.plist")
with open(Info_plist, 'rb') as f:
Info = plistlib.load(f)
# https://www.bugsplat.com/docs/platforms/os-x#configuration
Info["BugsplatServerURL"] = \
"https://{}.bugsplat.com/".format(bugsplat_db)
self.put_in_file(
plistlib.dumps(Info),
os.path.basename(Info_plist),
"Info.plist")
with self.prefix(dst="Contents"): # everything goes in Contents
# CEF framework goes inside Contents/Frameworks.
# Remember where we parked this car.
with self.prefix(src=relpkgdir, dst="Frameworks"):
self.path("libndofdev.dylib")
if self.args.get('bugsplat'):
self.path2basename(relpkgdir, "BugsplatMac.framework")
# OpenAL dylibs
if self.args['openal'] == 'ON':
for libfile in (
"libopenal.dylib",
"libalut.dylib",
):
self.path(libfile)
# WebRTC libraries
with self.prefix(src=os.path.join(self.args['build'], os.pardir,
'sharedlibs', self.args['buildtype'], 'Resources')):
for libfile in (
'libllwebrtc.dylib',
):
self.path(libfile)
with self.prefix(dst="MacOS"):
executable = self.dst_path_of(CHANNEL_VENDOR_BASE)
if self.args.get('bugsplat'):
# According to Apple Technical Note TN2206:
# https://developer.apple.com/library/archive/technotes/tn2206/_index.html#//apple_ref/doc/uid/DTS40007919-CH1-TNTAG207
# "If an app uses @rpath or an absolute path to link to a
# dynamic library outside of the app, the app will be
# rejected by Gatekeeper. ... Neither the codesign nor the
# spctl tool will show the error."
# (Thanks, Apple. Maybe fix spctl to warn?)
# The BugsplatMac framework embeds @rpath, which is
# causing scary Gatekeeper popups at viewer start. Work
# around this by changing the reference baked into our
# viewer. The install_name_tool -change option needs the
# previous value. Instead of guessing -- which might
# silently be defeated by a BugSplat SDK update that
# changes their baked-in @rpath -- ask for the path
# stamped into the framework.
# Let exception, if any, propagate -- if this doesn't
# work, we need the build to noisily fail!
oldpath = subprocess.check_output(
['objdump', '--macho', '--dylib-id', '--non-verbose',
os.path.join(relpkgdir, "BugsplatMac.framework", "BugsplatMac")],
text=True
).splitlines()[-1] # take the last line of output
self.run_command(
['install_name_tool', '-change', oldpath,
'@executable_path/../Frameworks/BugsplatMac.framework/BugsplatMac',
executable])
# NOTE: the -S argument to strip causes it to keep
# enough info for annotated backtraces (i.e. function
# names in the crash log). 'strip' with no arguments
# yields a slightly smaller binary but makes crash
# logs mostly useless. This may be desirable for the
# final release. Or not.
if ("package" in self.args['actions'] or
"unpacked" in self.args['actions']):
self.run_command(
['strip', '-S', executable])
# most everything goes in the Resources directory
with self.prefix(dst="Resources"):
super().construct()
with self.prefix(src_dst="cursors_mac"):
self.path("*.tif")
self.path("licenses-mac.txt", dst="licenses.txt")
self.path("featuretable_mac.txt")
self.path("cube.dae")
self.path("VivoxAUP.txt")
self.path("LGPL-license.txt")
with self.prefix(src=pkgdir,dst=""):
self.path("ca-bundle.crt")
icon_path = self.icon_path()
with self.prefix(src=icon_path) :
self.path("firestorm_icon.icns")
# Translations
self.path("English.lproj/language.txt")
self.replace_in(src="English.lproj/InfoPlist.strings",
dst="English.lproj/InfoPlist.strings",
searchdict={'%%VERSION%%':'.'.join(self.args['version'])}
)
self.path("German.lproj")
self.path("Japanese.lproj")
self.path("Korean.lproj")
self.path("da.lproj")
self.path("es.lproj")
self.path("fr.lproj")
self.path("hu.lproj")
self.path("it.lproj")
self.path("nl.lproj")
self.path("pl.lproj")
self.path("pt.lproj")
self.path("ru.lproj")
self.path("tr.lproj")
self.path("uk.lproj")
self.path("zh-Hans.lproj")
def path_optional(src, dst):
"""
For a number of our self.path() calls, not only do we want
to deal with the absence of src, we also want to remember
which were present. Return either an empty list (absent)
or a list containing dst (present). Concatenate these
return values to get a list of all libs that are present.
"""
# This was simple before we started needing to pass
# wildcards. Fortunately, self.path() ends up appending a
# (source, dest) pair to self.file_list for every expanded
# file processed. Remember its size before the call.
oldlen = len(self.file_list)
try:
self.path(src, dst)
# The dest appended to self.file_list has been prepended
# with self.get_dst_prefix(). Strip it off again.
added = [os.path.relpath(d, self.get_dst_prefix())
for s, d in self.file_list[oldlen:]]
except MissingError as err:
print("Warning: "+err.msg, file=sys.stderr)
added = []
if not added:
print("Skipping %s" % dst)
return added
# dylibs is a list of all the .dylib files we expect to need
# in our bundled sub-apps. For each of these we'll create a
# symlink from sub-app/Contents/Resources to the real .dylib.
# Need to get the llcommon dll from any of the build directories as well.
libfile_parent = self.get_dst_prefix()
libfile = "libllcommon.dylib"
dylibs = []
for libfile in (
"libGLOD.dylib",
"libgrowl.dylib",
"libgrowl++.dylib",
):
dylibs += path_optional(os.path.join(relpkgdir, libfile), libfile)
# SLVoice executable
with self.prefix(src=os.path.join(pkgdir, 'bin', 'release')):
self.path("SLVoice")
# Vivox libraries
for libfile in (
'libortp.dylib',
'libvivoxsdk.dylib',
):
self.path2basename(relpkgdir, libfile)
# Discord social SDK
if self.args['discord'] == 'ON':
for libfile in (
"libdiscord_partner_sdk.dylib",
):
self.path2basename(relpkgdir, libfile)
# Fmod studio dylibs (vary based on configuration)
# <FS:Beq> Fix intolerant processing of booleans
# if self.args['fmodstudio'].lower() == 'ON':
usefmod = self.args['fmodstudio'].lower()
print(f"debug: fmodstudio={usefmod}")
if usefmod == 'on':
if self.args['buildtype'].lower() == 'debug':
print("debug: fmodstudio is used in debug")
for libfile in (
"libfmodL.dylib",
):
dylibs += path_optional(os.path.join(debpkgdir, libfile), libfile)
else:
print("debug: fmodstudio is used in release")
for libfile in (
"libfmod.dylib",
):
print("debug: adding {} to dylibs for fmodstudio".format(path_optional(os.path.join(relpkgdir, libfile), libfile)))
dylibs += path_optional(os.path.join(relpkgdir, libfile), libfile)
print(f"debug: dylibs = {dylibs}")
# our apps
executable_path = {}
embedded_apps = [ (os.path.join("llplugin", "slplugin"), "SLPlugin.app") ]
for app_bld_dir, app in embedded_apps:
self.path2basename(os.path.join(os.pardir,
app_bld_dir, self.args['configuration']),
app)
executable_path[app] = \
self.dst_path_of(os.path.join(app, "Contents", "MacOS"))
# Dullahan helper apps go inside SLPlugin.app
with self.prefix(dst=os.path.join(
"SLPlugin.app", "Contents", "Frameworks")):
# copy CEF plugin
self.path2basename("../media_plugins/cef/" + self.args['configuration'],
"media_plugin_cef.dylib")
# copy LibVLC plugin
self.path2basename("../media_plugins/libvlc/" + self.args['configuration'],
"media_plugin_libvlc.dylib")
# CEF framework and vlc libraries goes inside Contents/Frameworks.
with self.prefix(src=os.path.join(pkgdir, 'lib', 'release')):
self.path("Chromium Embedded Framework.framework")
self.path("DullahanHelper.app")
self.path("DullahanHelper (Alerts).app")
self.path("DullahanHelper (GPU).app")
self.path("DullahanHelper (Renderer).app")
self.path("DullahanHelper (Plugin).app")
# Copy libvlc
self.path( "libvlc*.dylib*" )
# copy LibVLC plugins folder
with self.prefix(src='plugins', dst="plugins"):
self.path( "*.dylib" )
self.path( "plugins.dat" )
# NOTE: the -S argument to strip causes it to keep enough info for
# annotated backtraces (i.e. function names in the crash log). 'strip' with no
# arguments yields a slightly smaller binary but makes crash logs mostly useless.
# This may be desirable for the final release. Or not.
if ("package" in self.args['actions'] or
"unpacked" in self.args['actions']):
self.run_command_shell('strip -S %(viewer_binary)r' %
{ 'viewer_binary' : self.dst_path_of('Contents/MacOS/Firestorm')})
# </FS:Ansariel> construct method VMP trampoline crazy VMP launcher juggling shamelessly replaced with old version
def package_finish(self):
global CHANNEL_VENDOR_BASE
# MBW -- If the mounted volume name changes, it breaks the .DS_Store's background image and icon positioning.
# If we really need differently named volumes, we'll need to create multiple DS_Store file images, or use some other trick.
volname=CHANNEL_VENDOR_BASE+" Installer" # DO NOT CHANGE without understanding comment above
# <FS:ND> Make sure all our package names look similar
#imagename = self.installer_base_name_mac()
imagename = self.fs_installer_basename()
# </FS:ND>
sparsename = imagename + ".sparseimage"
finalname = imagename + ".dmg"
# make sure we don't have stale files laying about
self.remove(sparsename, finalname)
self.run_command(['hdiutil', 'create', sparsename,
'-volname', volname, '-fs', 'HFS+',
'-type', 'SPARSE', '-megabytes', '1300',
'-layout', 'SPUD'])
# mount the image and get the name of the mount point and device node
try:
hdi_output = subprocess.check_output(['hdiutil', 'attach', '-private', sparsename], text=True)
except subprocess.CalledProcessError as err:
sys.exit("failed to mount image at '%s'" % sparsename)
try:
devfile = re.search(r"/dev/disk([0-9]+)[^s]", hdi_output).group(0).strip()
volpath = re.search(r'HFS\s+(.+)', hdi_output).group(1).strip()
# Copy everything in to the mounted .dmg
app_name = self.app_name()
# Hack:
# Because there is no easy way to coerce the Finder into positioning
# the app bundle in the same place with different app names, we are
# adding multiple .DS_Store files to svn. There is one for release,
# one for release candidate and one for first look. Any other channels
# will use the release .DS_Store, and will look broken.
# - Ambroff 2008-08-20
#<FS:TS> Select proper directory based on flavor and build type
dmg_template_prefix = 'firestorm'
if self.fs_is_opensim():
dmg_template_prefix = 'firestormos'
dmg_template = os.path.join(
'installers', 'darwin', '%s-%s-dmg' % (dmg_template_prefix, self.channel_type()))
print ("Trying template directory", dmg_template)
if not os.path.exists (self.src_path_of(dmg_template)):
dmg_template = os.path.join ('installers', 'darwin', 'release-dmg')
print ("Not found, trying template directory", dmg_template)
for s,d in list({self.get_dst_prefix():app_name + ".app",
#os.path.join(dmg_template, "_VolumeIcon.icns"): ".VolumeIcon.icns",
os.path.join(dmg_template, "background.png"): "background.png",
os.path.join(dmg_template, "_DS_Store"): ".DS_Store"}.items()):
print("Copying to dmg", s, d)
self.copy_action(self.src_path_of(s), os.path.join(volpath, d))
# <FS:TS> The next two commands *MUST* execute before the loop
# that hides the files. If not, packaging will fail.
# YOU HAVE BEEN WARNED.
# Create the alias file (which is a resource file) from the .r
self.run_command(
['Rez', self.src_path_of("%s/Applications-alias.r" % dmg_template),
'-o', os.path.join(volpath, "Applications")])
# Set up the installer disk image: set icon positions, folder view
# options, and icon label colors. This must be done before the
# files are hidden.
self.run_command(
['osascript',
self.src_path_of("installers/darwin/installer-dmg.applescript"),
volname])
# <FS:TS> ARGH! osascript clobbers the volume icon file, for no
# reason I can find anywhere. So we need to copy it after
# running the script to set everything else up.
print ("Copying volume icon to dmg")
self.copy_action(self.src_path_of(os.path.join(dmg_template, "_VolumeIcon.icns")),
os.path.join(volpath, ".VolumeIcon.icns"))
# Hide the background image, DS_Store file, and volume icon file (set their "visible" bit)
for f in ".VolumeIcon.icns", "background.png", ".DS_Store":
pathname = os.path.join(volpath, f)
self.run_command(['SetFile', '-a', 'V', pathname])
# Set the alias file's alias and custom icon bits
self.run_command(['SetFile', '-a', 'AC', os.path.join(volpath, "Applications")])
# Set the disk image root's custom icon bit
self.run_command(['SetFile', '-a', 'C', volpath])
# Sign the app if requested;
# do this in the copy that's in the .dmg so that the extended attributes used by
# the signature are preserved; moving the files using python will leave them behind
# and invalidate the signatures.
if 'signature' in self.args:
app_in_dmg=os.path.join(volpath,self.app_name()+".app")
print("Attempting to sign '%s'" % app_in_dmg)
identity = self.args['signature']
if identity == '':
identity = 'Developer ID Application'
ad_hoc_sign = False
# Look for an environment variable set via build.sh when running in Team City.
try:
build_secrets_checkout = os.environ['build_secrets_checkout']
except KeyError:
ad_hoc_sign = True # A minimum of ad-hoc signing is a requirement for arm64 builds to behave correctly
identity = '-' # Ad-hoc identity
finally:
if not ad_hoc_sign:
# variable found so use it to unlock keychain followed by codesign
home_path = os.environ['HOME']
keychain_pwd_path = os.path.join(build_secrets_checkout,'code-signing-osx','password.txt')
keychain_pwd = open(keychain_pwd_path).read().rstrip()
# Note: As of macOS Sierra, keychains are created with
# names postfixed with '-db' so for example, the SL
# Viewer keychain would by default be found in
# ~/Library/Keychains/viewer.keychain-db instead of
# just ~/Library/Keychains/viewer.keychain in
# earlier versions.
#
# Because we have old OS files from previous
# versions of macOS on the build hosts, the
# configurations are different on each host. Some
# have viewer.keychain, some have viewer.keychain-db
# and some have both. As you can see in the line
# below, this script expects the Linden Developer
# cert/keys to be in viewer.keychain.
#
# To correctly sign builds you need to make sure
# ~/Library/Keychains/viewer.keychain exists on the
# host and that it contains the correct cert/key. If
# a build host is set up with a clean version of
# macOS Sierra (or later) then you will need to
# change this line (and the one for 'codesign'
# command below) to point to right place or else
# pull in the cert/key into the default viewer
# keychain 'viewer.keychain-db' and export it to
# 'viewer.keychain'
viewer_keychain = os.path.join(home_path, 'Library',
'Keychains', 'viewer.keychain')
if not os.path.isfile( viewer_keychain ):
viewer_keychain += "-db"
if not os.path.isfile( viewer_keychain ):
raise "No keychain named viewer found"
self.run_command(['security', 'unlock-keychain',
'-p', keychain_pwd, viewer_keychain])
with tempfile.TemporaryDirectory() as tmpdir:
tmp_app_path = os.path.join(tmpdir, self.app_name() + ".app")
print("Copying app to temporary folder for signing:", tmp_app_path)
subprocess.run(['ditto', app_in_dmg, tmp_app_path], check=True)
sign_retry_wait=15
resources = tmp_app_path + "/Contents/Resources/"
plain_sign = glob.glob(resources + "llplugin/*.dylib")
# <FS:ND> Even though we got some dylibs in Resources signed by LL, we also got some there that are *NOT*
# At least: fmod, growl, GLOD
# We could selectively sign those, or repackage them and then sign them. For an easy clean sweet we just resign them al
plain_sign += glob.glob(resources + "*.dylib")
plain_sign += glob.glob(resources + "llplugin/lib/*.dylib")
plain_sign += glob.glob(resources + "SLPlugin.app/Contents/Frameworks/Chromium Embedded Framework.framework/Libraries/*.dylib")
deep_sign = [
# <FS:ND> Firestorm does not ship SLVersionChecker
#resources + "updater/SLVersionChecker",
resources + "SLPlugin.app/Contents/MacOS/SLPlugin",
resources + "SLVoice",
tmp_app_path,
]
for attempt in range(3):
if attempt: # second or subsequent iteration
print("codesign failed, waiting {:d} seconds before retrying".format(sign_retry_wait),
file=sys.stderr)
time.sleep(sign_retry_wait)
sign_retry_wait*=2
try:
# Note: See blurb above about names of keychains
for signee in plain_sign:
args = [
'codesign',
'--force',
'--timestamp'
]
if not ad_hoc_sign:
args += ['--keychain', viewer_keychain]
args += ['--sign', identity, signee]
self.run_command(args)
for signee in deep_sign:
args = [
'codesign',
'--verbose',
'--deep',
'--force',
'--entitlements', self.src_path_of("slplugin.entitlements"),
'--options', 'runtime'
]
if not ad_hoc_sign:
args += ['--keychain', viewer_keychain]
args += ['--sign', identity, signee]
self.run_command(args)
break # if no exception was raised, the codesign worked
except ManifestError as err:
# 'err' goes out of scope
sign_failed = err
else:
print("Maximum codesign attempts exceeded; giving up", file=sys.stderr)
raise sign_failed
# Signing succeeded, now delete the original app in the mounted sparse image and notarize if needed
shutil.rmtree(app_in_dmg)
if not ad_hoc_sign:
# <FS:ND> This fails sometimes and works other times. Even when notarization (down below) is a success
# Remove it for now and investigate after we did notarize a few times
#self.run_command(['spctl', '-a', '-texec', '-vvvv', app_in_dmg])
self.run_command([self.src_path_of("installers/darwin/apple-notarize.sh"), tmp_app_path])
print("Copying signed app back into mounted sparse image")
subprocess.run(['ditto', tmp_app_path, app_in_dmg], check=True)
finally:
# Unmount the image even if exceptions from any of the above
for tries in range(10):
try:
self.run_command(['hdiutil', 'detach', '-force', devfile])
break # Exit loop if detach worked
except ManifestError as err:
print(f"detach failed on attempt {tries}")
time.sleep(1)
print("Converting temp disk image to final disk image")
self.run_command(['hdiutil', 'convert', sparsename, '-format', 'UDZO',
'-imagekey', 'zlib-level=9', '-o', finalname])
# get rid of the temp file
self.package_file = finalname
self.remove(sparsename)
self.fs_save_osx_symbols()
class LinuxManifest(ViewerManifest):
build_data_json_platform = 'lnx'
def construct(self):
# <FS:ND> HACK! Force parent to always copy XML/... even when not having configured with --package.
# This allows build result to be started without always having to --package and thus waiting for the length tar ball generation --package incurs
savedActions = self.args['actions']
self.args["actions"].append("package")
super(LinuxManifest, self).construct()
self.args["actions"] = savedActions # Restore old actions
pkgdir = os.path.join(self.args['build'], os.pardir, 'packages')
relpkgdir = os.path.join(pkgdir, "lib", "release")
debpkgdir = os.path.join(pkgdir, "lib", "debug")
self.path("licenses-linux.txt","licenses.txt")
self.path("VivoxAUP.txt")
self.path("LGPL-license.txt")
self.path("res/firestorm_icon.png","firestorm_icon.png")
with self.prefix("linux_tools"):
self.path("client-readme.txt","README-linux.txt")
self.path("FIRESTORM_DESKTOPINSTALL.txt","FIRESTORM_DESKTOPINSTALL.txt")
self.path("client-readme-voice.txt","README-linux-voice.txt")
self.path("client-readme-joystick.txt","README-linux-joystick.txt")
self.path("wrapper.sh","firestorm")
with self.prefix(dst="etc"):
self.path("handle_secondlifeprotocol.sh")
self.path("register_secondlifeprotocol.sh")
self.path("refresh_desktop_app_entry.sh")
self.path("launch_url.sh")
self.path("install.sh")
with self.prefix(dst="bin"):
self.path( os.path.join(os.pardir,'build_data.json'), "build_data.json" )
self.path("firestorm-bin","do-not-directly-run-firestorm-bin")
self.path("../linux_crash_logger/linux-crash-logger","linux-crash-logger.bin")
self.path2basename("../llplugin/slplugin", "SLPlugin")
#this copies over the python wrapper script, associated utilities and required libraries, see SL-321, SL-322 and SL-323
# <FS:Ansariel> Remove VMP
# with self.prefix(src="../viewer_components/manager", dst=""):
# self.path("*.py")
# </FS:Ansariel> Remove VMP
# recurses, packaged again
self.path("res-sdl")
# Get the icons based on the channel type
icon_path = self.icon_path()
print("DEBUG: icon_path '%s'" % icon_path)
with self.prefix(src=icon_path) :
self.path("firestorm_256.png","firestorm_48.png")
#with self.prefix(dst="res-sdl") :
# self.path("firestorm_256.bmp","ll_icon.BMP")
# plugins
with self.prefix(src=os.path.join(self.args['build'], os.pardir, 'media_plugins'), dst="bin/llplugin"):
self.path("gstreamer10/libmedia_plugin_gstreamer10.so", "libmedia_plugin_gstreamer.so")
self.path("cef/libmedia_plugin_cef.so", "libmedia_plugin_cef.so" )
# CEF files
with self.prefix(src=os.path.join(pkgdir, 'lib', 'release'), dst="lib"):
self.path( "libcef.so" )
self.path( "libEGL*" )
self.path( "libvulkan*" )
self.path( "libvk_swiftshader*" )
self.path( "libGLESv2*" )
with self.prefix(src=os.path.join(pkgdir, 'bin', 'release'), dst="bin"):
self.path( "chrome-sandbox" )
self.path( "dullahan_host" )
with self.prefix(src=os.path.join(pkgdir, 'lib', 'release'), dst="bin"):
self.path( "v8_context_snapshot.bin" )
self.path( "vk_swiftshader_icd.json")
with self.prefix(src=os.path.join(pkgdir, 'lib', 'release'), dst="lib"):
self.path( "v8_context_snapshot.bin" )
self.path( "vk_swiftshader_icd.json")
with self.prefix(src=os.path.join(pkgdir, 'resources'), dst="lib"):
self.path( "chrome_100_percent.pak" )
self.path( "chrome_200_percent.pak" )
self.path( "resources.pak" )
self.path( "icudtl.dat" )
with self.prefix(src=os.path.join(pkgdir, 'resources', 'locales'), dst=os.path.join('lib', 'locales')):
self.path("*.pak")
self.path("featuretable_linux.txt")
self.path("cube.dae")
with self.prefix(src=pkgdir, dst="bin"):
self.path("ca-bundle.crt")
with self.prefix(src=os.path.join(pkgdir, 'lib', 'release'), dst="lib"):
# self.path("libfreetype.so*")
self.path("libapr-1.so*")
self.path("libaprutil-1.so*")
#self.path("libboost_context-mt.so*")
#self.path("libboost_filesystem-mt.so*")
#self.path("libboost_program_options-mt.so*")
#self.path("libboost_regex-mt.so*")
#self.path("libboost_signals-mt.so*")
#self.path("libboost_system-mt.so*")
#self.path("libboost_thread-mt.so*")
#self.path("libboost_chrono-mt.so*") #<FS:TM> FS spcific
#self.path("libboost_date_time-mt.so*") #<FS:TM> FS spcific
#self.path("libboost_wave-mt.so*") #<FS:TM> FS spcific
#self.path("libcollada14dom.so*")
#self.path("libdb*.so*")
#self.path("libcrypto.so*")
#self.path("libexpat.so*")
#self.path("libssl.so*")
#self.path("libGLOD.so")
#self.fs_path("libminizip.so")
self.path("libuuid.so*")
self.path("libSDL*.so*")
self.path_optional("libdirectfb*.so*")
self.path_optional("libfusion*.so*")
self.path_optional("libdirect*.so*")
self.path_optional("libopenjpeg.so*")
self.path("libalut.so*")
#self.path("libpng15.so.15") #use provided libpng to workaround incompatible system versions on some distros
#self.path("libpng15.so.15.13.0") #use provided libpng to workaround incompatible system versions on some distros
#self.path("libpng15.so.15.1.0") #use provided libpng to workaround incompatible system versions on some distros
self.path("libopenal.so", "libopenal.so.1") # Install as versioned file in case it's missing from the 3p- and won't get copied below
self.path("libopenal.so*")
#self.path("libnotify.so.1.1.2", "libnotify.so.1") # LO - uncomment when testing libnotify(growl) on linux
#self.path("libpangox-1.0.so*")
# KLUDGE: As of 2012-04-11, the 'fontconfig' package installs
# libfontconfig.so.1.4.4, along with symlinks libfontconfig.so.1
# and libfontconfig.so. Before we added support for library-file
# wildcards, though, this self.path() call specifically named
# libfontconfig.so.1.4.4 WITHOUT also copying the symlinks. When I
# (nat) changed the call to self.path("libfontconfig.so.*"), we
# ended up with the libfontconfig.so.1 symlink in the target
# directory as well. But guess what! At least on Ubuntu 10.04,
# certain viewer fonts look terrible with libfontconfig.so.1
# present in the target directory. Removing that symlink suffices
# to improve them. I suspect that means we actually do better when
# the viewer fails to find our packaged libfontconfig.so*, falling
# back on the system one instead -- but diagnosing and fixing that
# is a bit out of scope for the present project. Meanwhile, this
# particular wildcard specification gets us exactly what the
# previous call did, without having to explicitly state the
# version number.
#self.path("libfontconfig.so.*.*")
self.path_optional("libjemalloc.so*")
# WebRTC libraries
with self.prefix(src=os.path.join(self.args['build'], os.pardir,
'sharedlibs', 'lib'), dst='lib'):
for libfile in (
'libllwebrtc.so',
):
self.path(libfile)
# Vivox runtimes
# Currentelly, the 32-bit ones will work with a 64-bit client.
with self.prefix(src=os.path.join(pkgdir, 'bin32' ), dst="bin"):
self.path("SLVoice")
with self.prefix(src=os.path.join(pkgdir ), dst="bin"):
self.path("win32")
self.path("win64")
with self.prefix(src=os.path.join(pkgdir, 'lib32' ), dst="lib32"):
self.path("libvivox*")
self.path("libortp*")
self.path("libsndfile*")
self.path("*.crt")
def package_finish(self):
# a standard map of strings for replacing in the templates
#installer_name = self.installer_base_name()
installer_name = self.fs_installer_basename()
self.fs_save_breakpad_symbols("linux")
self.fs_delete_linux_symbols() # <FS:ND/> Delete old syms
self.strip_binaries()
self.fs_save_linux_symbols() # <FS:ND/> Package symbols, add debug link
# Fix access permissions
self.run_command(['find', self.get_dst_prefix(),
'-type', 'd', '-exec', 'chmod', '755', '{}', ';'])
for old, new in ('0700', '0755'), ('0500', '0555'), ('0600', '0644'), ('0400', '0444'):
self.run_command(['find', self.get_dst_prefix(),
'-type', 'f', '-perm', old,
'-exec', 'chmod', new, '{}', ';'])
self.package_file = installer_name + '.tar.xz'
# temporarily move directory tree so that it has the right
# name in the tarfile
realname = self.get_dst_prefix()
tempname = self.build_path_of(installer_name)
self.run_command(["mv", realname, tempname])
try:
# only create tarball if it's a release build.
if self.args['buildtype'].lower() == 'release':
# --numeric-owner hides the username of the builder for
# security etc.
self.run_command(['tar', '-C', self.get_build_prefix(),
'--numeric-owner', self.fs_linux_tar_excludes(), '-caf',
tempname + '.tar.xz', installer_name])
else:
print("Skipping %s.tar.xz for non-Release build (%s)" % \
(installer_name, self.args['buildtype']))
finally:
self.run_command(["mv", tempname, realname])
def strip_binaries(self):
if self.args['buildtype'].lower() == 'release' and self.is_packaging_viewer():
print("* Going strip-crazy on the packaged binaries, since this is a RELEASE build")
# makes some small assumptions about our packaged dir structure
self.run_command(
["find"] +
[os.path.join(self.get_dst_prefix(), dir) for dir in ('bin', 'lib')] +
# <FS:Ansariel> Remove VMP
# ['-type', 'f', '!', '-name', '*.py',
['-type', 'f', "!", "-name", "*.dat", "!", "-name", "*.pak", "!", "-name", "*.bin", "!", "-name", "*.lib", "!", "-name", "*.pdb",
# </FS:Ansariel> Remove VMP
'!', '-name', 'update_install', '-exec', 'strip', '-S', '{}', ';'])
class Linux_i686_Manifest(LinuxManifest):
address_size = 32
def construct(self):
super(Linux_i686_Manifest, self).construct()
pkgdir = os.path.join(self.args['build'], os.pardir, 'packages')
relpkgdir = os.path.join(pkgdir, "lib", "release")
debpkgdir = os.path.join(pkgdir, "lib", "debug")
with self.prefix(src=relpkgdir, dst="lib"):
self.path("libdb*.so")
self.path("libGLOD.so")
self.path("libuuid.so*")
self.path("libSDL-1.2.so.*")
self.path("libdirectfb-1.*.so.*")
self.path("libfusion-1.*.so.*")
self.path("libdirect-1.*.so.*")
#self.path("libopenjp2.so*")
self.path("libdirectfb-1.4.so.5")
self.path("libfusion-1.4.so.5")
self.path("libdirect-1.4.so.5*")
self.path("libalut.so*")
self.path("libopenal.so*")
# <FS:ND> Linking this breaks voice as stock openal.so does not have alcGetMixedBuffer
#self.path("libopenal.so", "libvivoxoal.so.1") # vivox's sdk expects this soname
# </FS:ND>
# KLUDGE: As of 2012-04-11, the 'fontconfig' package installs
# libfontconfig.so.1.4.4, along with symlinks libfontconfig.so.1
# and libfontconfig.so. Before we added support for library-file
# wildcards, though, this self.path() call specifically named
# libfontconfig.so.1.4.4 WITHOUT also copying the symlinks. When I
# (nat) changed the call to self.path("libfontconfig.so.*"), we
# ended up with the libfontconfig.so.1 symlink in the target
# directory as well. But guess what! At least on Ubuntu 10.04,
# certain viewer fonts look terrible with libfontconfig.so.1
# present in the target directory. Removing that symlink suffices
# to improve them. I suspect that means we actually do better when
# the viewer fails to find our packaged libfontconfig.so*, falling
# back on the system one instead -- but diagnosing and fixing that
# is a bit out of scope for the present project. Meanwhile, this
# particular wildcard specification gets us exactly what the
# previous call did, without having to explicitly state the
# version number.
# self.path("libfontconfig.so.*.*") # <FS:PC> fontconfig and freetype should be taken from the user's system
# Include libfreetype.so. but have it work as libfontconfig does.
self.path("libfreetype.so.*.*")
try:
self.path("libtcmalloc.so*") #formerly called google perf tools
pass
except:
print("tcmalloc files not found, skipping")
pass
# if self.args['fmodstudio'] == 'ON':
if self.args['fmodstudio'].lower() == 'on':
try:
self.path("libfmod.so")
self.path("libfmod.so*")
pass
except:
print("Skipping libfmod.so - not found")
pass
# Vivox runtimes
with self.prefix(src=relpkgdir, dst="bin"):
self.path("SLVoice")
with self.prefix(src=relpkgdir, dst="lib"):
self.path("libortp.so")
self.path("libsndfile.so.1")
#self.path("libvivoxoal.so.1") # no - we'll re-use the viewer's own OpenAL lib
self.path("libvivoxsdk.so")
self.fs_delete_linux_symbols() # <FS:ND/> Delete old syms
self.strip_binaries()
class Linux_x86_64_Manifest(LinuxManifest):
address_size = 64
def construct(self):
super(Linux_x86_64_Manifest, self).construct()
pkgdir = os.path.join(self.args['build'], os.pardir, 'packages')
relpkgdir = os.path.join(pkgdir, "lib", "release")
debpkgdir = os.path.join(pkgdir, "lib", "debug")
with self.prefix(src=os.path.join(pkgdir, 'lib', 'release'), dst="lib"):
#self.path("libffi*.so*")
# vivox 32-bit hack.
# one has to extract libopenal.so from the 32-bit openal package, or official LL viewer, and rename it to libopenal32.so
# and place it in the prebuilt lib/release directory
# <FS:TS> No, we don't need to dink with this. A usable library
# is now in the slvoice package, and we need to just use it as is.
# self.path("libopenal32.so", "libvivoxoal.so.1") # vivox's sdk expects this soname
# if self.args['fmodstudio'] == 'ON':
if self.args['fmodstudio'].lower() == 'on':
try:
self.path("libfmod.so")
self.path("libfmod.so*")
pass
except:
print ("Skipping libfmod.so - not found")
pass
with self.prefix(dst="bin"):
self.path2basename("../llplugin/slplugin", "SLPlugin")
self.path("secondlife-i686.supp")
################################################################
# <FS:Ansariel> Added back for Mac compatibility reason
def symlinkf(src, dst):
"""
Like ln -sf, but uses os.symlink() instead of running ln.
"""
try:
os.symlink(src, dst)
except OSError as err:
if err.errno != errno.EEXIST:
raise
# We could just blithely attempt to remove and recreate the target
# file, but that strategy doesn't work so well if we don't have
# permissions to remove it. Check to see if it's already the
# symlink we want, which is the usual reason for EEXIST.
elif os.path.islink(dst):
if os.readlink(dst) == src:
# the requested link already exists
pass
else:
# dst is the wrong symlink; attempt to remove and recreate it
os.remove(dst)
os.symlink(src, dst)
elif os.path.isdir(dst):
print ("Requested symlink (%s) exists but is a directory; replacing" % dst)
shutil.rmtree(dst)
os.symlink(src, dst)
elif os.path.exists(dst):
print ("Requested symlink (%s) exists but is a file; replacing" % dst)
os.remove(dst)
os.symlink(src, dst)
else:
# see if the problem is that the parent directory does not exist
# and try to explain what is missing
(parent, tail) = os.path.split(dst)
while not os.path.exists(parent):
(parent, tail) = os.path.split(parent)
if tail:
raise Exception("Requested symlink (%s) cannot be created because %s does not exist"
% os.path.join(parent, tail))
else:
raise
# </FS:Ansariel> Added back for Mac compatibility reason
if __name__ == "__main__":
# Report our own command line so that, in case of trouble, a developer can
# manually rerun the same command.
print(('%s \\\n%s' %
(sys.executable,
' '.join((("'%s'" % arg) if ' ' in arg else arg) for arg in sys.argv))))
# fmodstudio and openal can be used simultaneously and controled by environment
extra_arguments = [
dict(name='bugsplat', description="""BugSplat database to which to post crashes,
if BugSplat crash reporting is desired""", default=''),
dict(name='discord', description="""Indication discord social sdk libraries are needed""", default='OFF'),
dict(name='fmodstudio', description="""Indication if fmod studio libraries are needed""", default='OFF'),
dict(name='openal', description="""Indication openal libraries are needed""", default='OFF'),
dict(name='tracy', description="""Indication tracy profiler is enabled""", default='OFF'),
dict(name='avx2', description="""Indication avx2 instruction set is enabled""", default='OFF'),
]
try:
main(extra=extra_arguments)
except (ManifestError, MissingError) as err:
sys.exit("\nviewer_manifest.py failed: "+err.msg)
except:
raise
Reference in New Issue View Git Blame Copy Permalink