-
Notifications
You must be signed in to change notification settings - Fork 73
/
appdirtool.go
1316 lines (1128 loc) · 46.4 KB
/
appdirtool.go
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
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package main
import (
"bufio"
"bytes"
"encoding/json"
"errors"
"fmt"
"io"
"io/ioutil"
"log"
"strconv"
"syscall"
"os"
"os/exec"
"path/filepath"
"strings"
)
import "debug/elf"
import "github.com/probonopd/go-appimage/internal/helpers"
import "github.com/otiai10/copy"
//go:generate go run genexclude.go
type QMLImport struct {
Classname string `json:"classname,omitempty"`
Name string `json:"name"`
Path string `json:"path,omitempty"`
Plugin string `json:"plugin,omitempty"`
RelativePath string `json:"relativePath,omitempty"`
Type string `json:"type"`
Version string `json:"version"`
}
var allELFs []string
var libraryLocations []string // All directories in the host system that may contain libraries
var quirksModePatchQtPrfxPath = false
var AppRunData = `#!/bin/sh
HERE="$(dirname "$(readlink -f "${0}")")"
MAIN=$(grep -r "^Exec=.*" "$HERE"/*.desktop | head -n 1 | cut -d "=" -f 2 | cut -d " " -f 1)
############################################################################################
# Use bundled paths
############################################################################################
export PATH="${HERE}"/usr/bin/:"${HERE}"/usr/sbin/:"${HERE}"/usr/games/:"${HERE}"/bin/:"${HERE}"/sbin/:"${PATH}"
export XDG_DATA_DIRS="${HERE}"/usr/share/:"${XDG_DATA_DIRS}"
############################################################################################
# Use bundled Python
############################################################################################
export PYTHONHOME="${HERE}"/usr/
############################################################################################
# Use bundled Tcl/Tk
############################################################################################
if [ -e "${HERE}"/usr/share/tcltk/tcl8.6 ] ; then
export TCL_LIBRARY="${HERE}"/usr/share/tcltk/tcl8.6:$TCL_LIBRARY:$TK_LIBRARY
export TK_LIBRARY="${HERE}"/usr/share/tcltk/tk8.6:$TK_LIBRARY:$TCL_LIBRARY
fi
############################################################################################
# Make it look more native on Gtk+ based systems
############################################################################################
case "${XDG_CURRENT_DESKTOP}" in
*GNOME*|*gnome*)
export QT_QPA_PLATFORMTHEME=gtk2
esac
############################################################################################
# If .ui files are in the AppDir, then chances are that we need to cd into usr/
# because we may have had to patch the absolute paths away in the binary
############################################################################################
UIFILES=$(find "$HERE" -name "*.ui")
if [ ! -z "$UIFILES" ] ; then
cd "$HERE/usr"
fi
############################################################################################
# Use bundled GStreamer
# NOTE: May need to remove libgstvaapi.so
############################################################################################
if [ ! -z $(find "${HERE}" -name "libgstcoreelements.so" -type f) ] ; then
export GST_PLUGIN_PATH=$(dirname $(readlink -f $(find "${HERE}" -name "libgstcoreelements.so" -type f | head -n 1)))
export GST_PLUGIN_SCANNER=$(find "${HERE}" -name "gst-plugin-scanner" -type f | head -n 1)
export GST_PLUGIN_SYSTEM_PATH=$GST_PLUGIN_PATH
env | grep GST
fi
############################################################################################
# Run experimental bundle that bundles everything if a private ld-linux-x86-64.so.2 is there
# This allows the bundle to run even on older systems than the one it was built on
############################################################################################
cd "$HERE/usr" # Not all applications will need this; TODO: Make this opt-in
MAIN_BIN=$(find "$HERE/usr/bin" -name "$MAIN" | head -n 1)
LD_LINUX=$(find "$HERE" -name 'ld-*.so.*' | head -n 1)
if [ -e "$LD_LINUX" ] ; then
echo "Run experimental self-contained bundle"
export GCONV_PATH="$HERE/usr/lib/gconv"
export FONTCONFIG_FILE="$HERE/etc/fonts/fonts.conf"
export GTK_EXE_PREFIX="$HERE/usr"
export GTK_THEME=Default # This one should be bundled so that it can work on systems without Gtk
export GDK_PIXBUF_MODULEDIR=$(find "$HERE" -name loaders -type d -path '*gdk-pixbuf*')
export GDK_PIXBUF_MODULE_FILE=$(find "$HERE" -name loaders.cache -type f -path '*gdk-pixbuf*') # Patched to contain no paths
# export LIBRARY_PATH=$GDK_PIXBUF_MODULEDIR # Otherwise getting "Unable to load image-loading module"
export XDG_DATA_DIRS="${HERE}"/usr/share/:"${XDG_DATA_DIRS}"
export PERLLIB="${HERE}"/usr/share/perl5/:"${HERE}"/usr/lib/perl5/:"${PERLLIB}"
export GSETTINGS_SCHEMA_DIR="${HERE}"/usr/share/glib-2.0/schemas/:"${GSETTINGS_SCHEMA_DIR}"
export QT_PLUGIN_PATH="${HERE}"/usr/lib/qt4/plugins/:"${HERE}"/usr/lib/i386-linux-gnu/qt4/plugins/:"${HERE}"/usr/lib/x86_64-linux-gnu/qt4/plugins/:"${HERE}"/usr/lib32/qt4/plugins/:"${HERE}"/usr/lib64/qt4/plugins/:"${HERE}"/usr/lib/qt5/plugins/:"${HERE}"/usr/lib/i386-linux-gnu/qt5/plugins/:"${HERE}"/usr/lib/x86_64-linux-gnu/qt5/plugins/:"${HERE}"/usr/lib32/qt5/plugins/:"${HERE}"/usr/lib64/qt5/plugins/:"${QT_PLUGIN_PATH}"
# exec "${LD_LINUX}" --inhibit-cache --library-path "${LIBRARY_PATH}" "${MAIN_BIN}" "$@"
case $line in
"ld-linux"*) exec "${LD_LINUX}" --inhibit-cache "${MAIN_BIN}" "$@" ;;
*) exec "${LD_LINUX}" "${MAIN_BIN}" "$@" ;;
esac
else
exec "${MAIN_BIN}" "$@"
fi
`
type ELF struct {
path string
relpaths []string
rpath string
}
// Key: name of the package, value: location of the copyright file
var copyrightFiles = make(map[string]string) // Need to use 'make', otherwise we can't add to it
// Key: Path of the file, value: name of the package
var packagesContainingFiles = make(map[string]string) // Need to use 'make', otherwise we can't add to it
/*
man ld.so says:
If a shared object dependency does not contain a slash, then it is searched for in the following order:
o Using the directories specified in the DT_RPATH dynamic section attribute of the binary if present and DT_RUNPATH attribute does not exist. Use
of DT_RPATH is deprecated.
o Using the environment variable LD_LIBRARY_PATH, unless the executable is being run in secure-execution mode (see below), in which case this vari‐
able is ignored.
o Using the directories specified in the DT_RUNPATH dynamic section attribute of the binary if present. Such directories are searched only to find
those objects required by DT_NEEDED (direct dependencies) entries and do not apply to those objects' children, which must themselves have their
own DT_RUNPATH entries. This is unlike DT_RPATH, which is applied to searches for all children in the dependency tree.
o From the cache file /etc/ld.so.cache, which contains a compiled list of candidate shared objects previously found in the augmented library path.
If, however, the binary was linked with the -z nodeflib linker option, shared objects in the default paths are skipped. Shared objects installed
in hardware capability directories (see below) are preferred to other shared objects.
NOTE: Clear Linux* OS has this in /var/cache/ldconfig/ld.so.cache
o In the default path /lib, and then /usr/lib. (On some 64-bit architectures, the default paths for 64-bit shared objects are /lib64, and then
/usr/lib64.) If the binary was linked with the -z nodeflib linker option, this step is skipped.
*/
func AppDirDeploy(path string) {
appdir, err := helpers.NewAppDir(path)
if err != nil {
helpers.PrintError("AppDir", err)
os.Exit(1)
}
log.Println("Gathering all required libraries for the AppDir...")
determineELFsInDirTree(appdir, appdir.Path)
// If there is a .so with the name libgdk_pixbuf inside the AppDir, then we need to
// bundle Gdk pixbuf loaders without which the bundled Gtk does not work
// cp /usr/lib/x86_64-linux-gnu/gdk-pixbuf-*/*/loaders/* usr/lib/x86_64-linux-gnu/gdk-pixbuf-*/*/loaders/
// cp /usr/lib/x86_64-linux-gnu/gdk-pixbuf-*/*/loaders.cache usr/lib/x86_64-linux-gnu/gdk-pixbuf-*/*/ -
// this file must also be patched not to contain paths to the libraries
for _, lib := range allELFs {
if strings.HasPrefix(filepath.Base(lib), "libgdk_pixbuf") {
log.Println("Determining Gdk pixbuf loaders (for GDK_PIXBUF_MODULEDIR and GDK_PIXBUF_MODULE_FILE)...")
locs, err := findWithPrefixInLibraryLocations("gdk-pixbuf")
if err != nil {
log.Println("Could not find Gdk pixbuf loaders")
os.Exit(1)
} else {
for _, loc := range locs {
determineELFsInDirTree(appdir, loc)
// We need to patch away the path to libpixbufloader-png.so from the file loaders.cache, similar to:
// sed -i -e 's|/usr/lib/x86_64-linux-gnu/gdk-pixbuf-2.0/2.10.0/loaders/||g' usr/lib/x86_64-linux-gnu/gdk-pixbuf-*/*/loaders.cache
// the patched file must not contain paths to the libraries
loadersCaches := helpers.FilesWithSuffixInDirectoryRecursive(loc, "loaders.cache")
if len(loadersCaches) < 1 {
helpers.PrintError("loadersCaches", errors.New("could not find loaders.cache"))
os.Exit(1)
}
err = copy.Copy(loadersCaches[0], appdir.Path+loadersCaches[0])
if err != nil {
helpers.PrintError("Could not copy loaders.cache", err)
os.Exit(1)
}
whatToPatchAway := helpers.FilesWithSuffixInDirectoryRecursive(loc, "libpixbufloader-png.so")
if len(whatToPatchAway) < 1 {
helpers.PrintError("whatToPatchAway", errors.New("could not find directory that contains libpixbufloader-png.so"))
break // os.Exit(1)
}
log.Println("Patching", appdir.Path+loadersCaches[0], "removing", filepath.Dir(whatToPatchAway[0])+"/")
err = PatchFile(appdir.Path+loadersCaches[0], filepath.Dir(whatToPatchAway[0])+"/", "")
if err != nil {
helpers.PrintError("PatchFile loaders.cache", err)
break // os.Exit(1)
}
}
}
break
}
}
// GStreamer
for _, lib := range allELFs {
if strings.HasPrefix(filepath.Base(lib), "libgstreamer-1.0") {
log.Println("Bundling GStreamer 1.0 directory (for GST_PLUGIN_PATH)...")
locs, err := findWithPrefixInLibraryLocations("gstreamer-1.0")
if err != nil {
log.Println("Could not find GStreamer 1.0 directory")
os.Exit(1)
} else {
log.Println("Bundling dependencies of GStreamer 1.0 directory...")
determineELFsInDirTree(appdir, locs[0])
}
// FIXME: This is not going to scale, every distribution is cooking their own soup,
// we need to determine the location of gst-plugin-scanner dynamically by parsing it out of libgstreamer-1.0
gstPluginScannerCandidates := []string{"/usr/libexec/gstreamer-1.0/gst-plugin-scanner", // Clear Linux* OS
"/usr/lib/x86_64-linux-gnu/gstreamer1.0/gstreamer-1.0/gst-plugin-scanner"} // sic! Ubuntu 18.04
for _, cand := range gstPluginScannerCandidates {
if helpers.Exists(cand) {
log.Println("Determining gst-plugin-scanner...")
determineELFsInDirTree(appdir, cand)
break
}
}
break
}
}
// Gtk 3 modules/plugins
// If there is a .so with the name libgtk-3 inside the AppDir, then we need to
// bundle Gdk modules/plugins
deployGtkDirectory(appdir, 3)
// Gtk 2 modules/plugins
// Same as above, but for Gtk 2
deployGtkDirectory(appdir, 2)
// ALSA
// FIXME: Doesn't seem to get loaded. Is ALSA_PLUGIN_DIR needed and working in ALSA?
// Is something like https://github.com/flatpak/freedesktop-sdk-images/blob/1.6/alsa-lib-plugin-path.patch needed in the bundled ALSA?
// TODO: What about the `share/alsa` subdirectory? libasound.so.* refers to it as well
for _, lib := range allELFs {
if strings.HasPrefix(filepath.Base(lib), "libasound.so") {
log.Println("Bundling alsa-lib directory (for <tbd>)...")
locs, err := findWithPrefixInLibraryLocations("alsa-lib")
if err != nil {
log.Println("Could not find alsa-lib directory")
log.Println("E.g., in Alpine Linux: apk add alsa-plugins alsa-plugins-pulse")
os.Exit(1)
} else {
log.Println("Bundling dependencies of alsa-lib directory...")
determineELFsInDirTree(appdir, locs[0])
}
break
}
}
// PulseAudio
// TODO: What about the `/usr/lib/pulse-*` directory?
for _, lib := range allELFs {
if strings.HasPrefix(filepath.Base(lib), "libpulse.so") {
log.Println("Bundling pulseaudio directory (for <tbd>)...")
locs, err := findWithPrefixInLibraryLocations("pulseaudio")
if err != nil {
log.Println("Could not find pulseaudio directory")
os.Exit(1)
} else {
log.Println("Bundling dependencies of pulseaudio directory...")
determineELFsInDirTree(appdir, locs[0])
}
break
}
}
log.Println("Patching ld-linux...")
cmd := exec.Command("patchelf", "--print-interpreter", appdir.MainExecutable)
out, err := cmd.CombinedOutput()
if err != nil {
fmt.Println(cmd.String())
helpers.PrintError("patchelf --print-interpreter "+appdir.MainExecutable+": "+string(out), err)
os.Exit(1)
}
ldLinux := strings.TrimSpace(string(out))
if helpers.Exists(appdir.Path+"/"+ldLinux) == true {
log.Println("Removing pre-existing", ldLinux+"...")
err = syscall.Unlink(appdir.Path + "/" + ldLinux)
if err != nil {
helpers.PrintError("Could not remove pre-existing ld-linux", err)
os.Exit(1)
}
}
// ld-linux might be a symlink; hence we first need to resolve it
src, err := os.Readlink(ldLinux)
if err != nil {
helpers.PrintError("Could not get the location of ld-linux", err)
src = ldLinux
}
if *standalonePtr == true {
log.Println("Deploying", ldLinux+"...")
err = copy.Copy(src, appdir.Path+ldLinux)
if err != nil {
helpers.PrintError("Could not copy ld-linux", err)
os.Exit(1)
}
// Do what we do in the Scribus AppImage script, namely
// sed -i -e 's|/usr|/xxx|g' lib/x86_64-linux-gnu/ld-linux-x86-64.so.2
err = PatchFile(appdir.Path+ldLinux, "/lib", "/XXX")
if err != nil {
helpers.PrintError("PatchFile", err)
os.Exit(1)
}
err = PatchFile(appdir.Path+ldLinux, "/usr", "/xxx")
if err != nil {
helpers.PrintError("PatchFile", err)
os.Exit(1)
}
log.Println("Determining gconv (for GCONV_PATH)...")
// Search in all of the system's library directories for a directory called gconv
// and put it into the a location which matches the GCONV_PATH we export in AppRun
gconvs, err := findWithPrefixInLibraryLocations("gconv")
if err == nil {
// Target location must match GCONV_PATH exported in AppRun
determineELFsInDirTree(appdir, gconvs[0])
}
} else {
log.Println("Not deploying", ldLinux, "because it was not requested or it is not needed")
}
if helpers.Exists(appdir.Path + "/usr/share/glib-2.0/schemas") {
log.Println("Compiling glib-2.0 schemas...")
// Do what we do in pkg2appimage
// Compile GLib schemas if the subdirectory is present in the AppImage
// AppRun has to export GSETTINGS_SCHEMA_DIR for this to work
if helpers.Exists(appdir.Path + "/usr/share/glib-2.0/schemas") {
cmd := exec.Command("glib-compile-schemas", ".")
cmd.Dir = appdir.Path + "/usr/share/glib-2.0/schemas"
err = cmd.Run()
if err != nil {
helpers.PrintError("Run glib-compile-schemas", err)
os.Exit(1)
}
}
}
if helpers.Exists(appdir.Path+"/etc/fonts") == false {
log.Println("Adding fontconfig symlink... (is this really the right thing to do?)")
err = os.MkdirAll(appdir.Path+"/etc/fonts", 0755)
if err != nil {
helpers.PrintError("MkdirAll", err)
os.Exit(1)
}
err = os.Symlink("/etc/fonts/fonts.conf", appdir.Path+"/etc/fonts/fonts.conf")
if err != nil {
helpers.PrintError("MkdirAll", err)
os.Exit(1)
}
}
// Check for the presence of Gtk .ui files
uifiles := helpers.FilesWithSuffixInDirectoryRecursive(appdir.Path, ".ui")
if len(uifiles) > 0 {
log.Println("Gtk .ui files found. Need to take care to have them loaded from a relative rather than absolute path")
log.Println("TODO: Check if they are at hardcoded absolute paths in the application and if yes, patch")
var dirswithUiFiles []string
for _, uifile := range uifiles {
dirswithUiFiles = helpers.AppendIfMissing(dirswithUiFiles, filepath.Dir(uifile))
err = PatchFile(appdir.MainExecutable, "/usr", "././")
if err != nil {
helpers.PrintError("PatchFile", err)
os.Exit(1)
}
}
log.Println("Directories with .ui files:", dirswithUiFiles)
}
log.Println("Adding AppRun...")
err = ioutil.WriteFile(appdir.Path+"/AppRun", []byte(AppRunData), 0755)
if err != nil {
helpers.PrintError("write AppRun", err)
os.Exit(1)
}
log.Println("Find out whether Qt is a dependency of the application to be bundled...")
qtVersionDetected := 0
if containsString(allELFs, "libQt5Core.so.5") == true {
log.Println("Detected Qt 5")
qtVersionDetected = 5
}
if containsString(allELFs, "libQtCore.so.4") == true {
log.Println("Detected Qt 4")
qtVersionDetected = 4
}
if qtVersionDetected > 0 {
handleQt(appdir, qtVersionDetected)
}
fmt.Println("")
log.Println("libraryLocations:")
for _, lib := range libraryLocations {
fmt.Println(lib)
}
fmt.Println("")
// This is used when calculating the rpath that gets written into the ELFs as they are copied into the AppDir
// and when modifying the ELFs that were pre-existing in the AppDir so that they become aware of the other locations
var libraryLocationsInAppDir []string
for _, lib := range libraryLocations {
if strings.HasPrefix(lib, appdir.Path) == false {
lib = appdir.Path + lib
}
libraryLocationsInAppDir = helpers.AppendIfMissing(libraryLocationsInAppDir, lib)
}
fmt.Println("")
log.Println("libraryLocationsInAppDir:")
for _, lib := range libraryLocationsInAppDir {
fmt.Println(lib)
}
fmt.Println("")
/*
fmt.Println("")
log.Println("allELFs:")
for _, lib := range allELFs {
fmt.Println(lib)
}
*/
log.Println("Only after this point should we start copying around any ELFs")
log.Println("Copying in and patching ELFs which are not already in the AppDir...")
// As soon as we bundle libnvidia*, we get a segfault.
// Hence we exit whenever libGL.so.1 requires libnvidia*
for _, elf := range allELFs {
if strings.HasPrefix(filepath.Base(elf), "libnvidia") {
log.Println("System (most likely libGL) uses libnvidia*, please build on another system that does not use NVIDIA drivers, exiting")
os.Exit(1)
}
}
for _, lib := range allELFs {
shoudDoIt := true
for _, excludePrefix := range ExcludedLibraries {
if strings.HasPrefix(filepath.Base(lib), excludePrefix) == true && *standalonePtr == false {
log.Println("Skipping", lib, "because it is on the excludelist")
shoudDoIt = false
break
}
}
if shoudDoIt == true && strings.HasPrefix(lib, appdir.Path) == false && helpers.Exists(appdir.Path+"/"+lib) == false {
err = helpers.CopyFile(lib, appdir.Path+"/"+lib)
if err != nil {
log.Println(appdir.Path+"/"+lib, "could not be copied:", err)
os.Exit(1)
}
}
patchRpathsInElf(appdir, libraryLocationsInAppDir, lib)
if strings.Contains(lib, "libQt5Core.so.5") {
log.Println("Patching qt_prfxpath, otherwise can't load platform plugin...")
f, err := os.Open(appdir.Path + "/" + lib) // Open file for reading/determining the offset
defer f.Close()
if err != nil {
helpers.PrintError("Could not open libQt5Core.so.5 for reading", err)
os.Exit(1)
}
f.Seek(0, 0)
// Search from the beginning of the file
search := []byte("qt_prfxpath=")
offset := ScanFile(f, search) + int64(len(search))
log.Println("Offset of qt_prfxpath:", offset)
/*
What does qt_prfxpath=. actually mean on a Linux system? Where is "."?
Looks like it means "relative to args[0]".
So 'qt_prfxpath=.' would be wrong if we load the application through ld-linux.so because that one
lives in, e.g., appdir/lib64 which is actually not where the Qt 'plugins' directory is.
Hence we do NOT have to patch qt_prfxpath=. but to q't_prfxpath=../opt/qt512/'
(the relative path from args[0] to the directory in which the Qt 'plugins' directory is)
*/
// Note: The following is correct only if we bundle (and run through) ld-linux; in all other cases
// we should calculate the relative path relative to the main binary
var qtPrefixDir string
for _, libraryLocationInAppDir := range libraryLocationsInAppDir {
if strings.HasSuffix(libraryLocationInAppDir, "/plugins/platforms") {
qtPrefixDir = filepath.Dir(filepath.Dir(libraryLocationInAppDir))
break
}
}
if qtPrefixDir == "" {
helpers.PrintError("Could not determine the the Qt prefix directory:", err)
os.Exit(1)
} else {
log.Println("Qt prefix directory in the AppDir:", qtPrefixDir)
}
relPathToQt, err := filepath.Rel(filepath.Dir(appdir.Path+ldLinux), qtPrefixDir)
if err != nil {
helpers.PrintError("Could not compute the location of the Qt plugins directory:", err)
os.Exit(1)
} else {
log.Println("Relative path from ld-linux to Qt prefix directory in the AppDir:", relPathToQt)
}
f, err = os.OpenFile(appdir.Path+"/"+lib, os.O_WRONLY, 0644) // Open file writable, why is this so complicated
defer f.Close()
if err != nil {
helpers.PrintError("Could not open libQt5Core.so.5 for writing", err)
os.Exit(1)
}
// Now that we know where in the file the information is, go write it
f.Seek(offset, 0)
if quirksModePatchQtPrfxPath == false {
_, err = f.Write([]byte(relPathToQt + "\x00"))
} else {
_, err = f.Write([]byte("." + "\x00"))
}
if err != nil {
helpers.PrintError("Could not patch qt_prfxpath in "+appdir.Path+"/"+lib, err)
}
}
}
log.Println("Copying in copyright files...")
for _, lib := range allELFs {
shoudDoIt := true
for _, excludePrefix := range ExcludedLibraries {
if strings.HasPrefix(filepath.Base(lib), excludePrefix) == true && *standalonePtr == false {
log.Println("Skipping copyright file for ", lib, "because it is on the excludelist")
shoudDoIt = false
break
}
}
if shoudDoIt == true && strings.HasPrefix(lib, appdir.Path) == false {
// Copy copyright files into the AppImage
copyrightFile, err := getCopyrightFile(lib)
// It is perfectly fine for this to error - on non-dpkg systems, or if lib was not in a deb package
if err == nil {
os.MkdirAll(filepath.Dir(appdir.Path+copyrightFile), 0755)
copy.Copy(copyrightFile, appdir.Path+copyrightFile)
}
}
}
log.Println("Done")
if *standalonePtr == true {
log.Println("To check whether it is really self-contained, run:")
fmt.Println("LD_LIBRARY_PATH='' find " + appdir.Path + " -type f -exec ldd {} 2>&1 \\; | grep '=>' | grep -v " + appdir.Path)
}
}
func patchRpathsInElf(appdir helpers.AppDir, libraryLocationsInAppDir []string, path string) {
if strings.HasPrefix(path, appdir.Path) == false {
path = filepath.Clean(appdir.Path + "/" + path)
}
var newRpathStringForElf string
var newRpathStrings []string
for _, libloc := range libraryLocationsInAppDir {
relpath, err := filepath.Rel(filepath.Dir(path), libloc)
if err != nil {
helpers.PrintError("Could not compute relative path", err)
}
newRpathStrings = append(newRpathStrings, "$ORIGIN/"+filepath.Clean(relpath))
}
newRpathStringForElf = strings.Join(newRpathStrings, ":")
// fmt.Println("Computed newRpathStringForElf:", appdir.Path+"/"+lib, newRpathStringForElf)
if strings.HasPrefix(filepath.Base(path), "ld-") == true {
log.Println("Not writing rpath in", path, "because its name starts with ld-...")
return
}
// Be sure that the file we want to patch exists
if helpers.Exists(path) == false {
log.Println(path, "does not exist, hence we cannot set its rpath, exiting")
os.Exit(1)
}
// Call patchelf to set the rpath
if helpers.Exists(path) == true {
// log.Println("Rewriting rpath of", path)
cmd := exec.Command("patchelf", "--set-rpath", newRpathStringForElf, path)
// log.Println(cmd.Args)
out, err := cmd.CombinedOutput()
if err != nil {
fmt.Println(cmd.String())
helpers.PrintError("patchelf --set-rpath "+path+": "+string(out), err)
os.Exit(1)
}
}
}
func deployGtkDirectory(appdir helpers.AppDir, gtkVersion int) {
for _, lib := range allELFs {
if strings.HasPrefix(filepath.Base(lib), "libgtk-"+strconv.Itoa(gtkVersion)) {
log.Println("Bundling Gtk", strconv.Itoa(gtkVersion), "directory (for GTK_EXE_PREFIX)...")
locs, err := findWithPrefixInLibraryLocations("gtk-" + strconv.Itoa(gtkVersion))
if err != nil {
log.Println("Could not find Gtk", strconv.Itoa(gtkVersion), "directory")
os.Exit(1)
} else {
for _, loc := range locs {
log.Println("Bundling dependencies of Gtk", strconv.Itoa(gtkVersion), "directory...")
determineELFsInDirTree(appdir, loc)
log.Println("Bundling Default theme for Gtk", strconv.Itoa(gtkVersion), "(for GTK_THEME=Default)...")
err = copy.Copy("/usr/share/themes/Default/gtk-"+strconv.Itoa(gtkVersion)+".0", appdir.Path+"/usr/share/themes/Default/gtk-"+strconv.Itoa(gtkVersion)+".0")
if err != nil {
helpers.PrintError("Copy", err)
os.Exit(1)
}
/*
log.Println("Bundling icons for Default theme...")
err = copy.Copy("/usr/share/icons/Adwaita", appdir.Path+"/usr/share/icons/Adwaita")
if err != nil {
helpers.PrintError("Copy", err)
os.Exit(1)
}
*/
}
}
break
}
}
}
// appendLib appends library in path to allELFs and adds its location as well as any pre-existing rpaths to libraryLocations
func appendLib(path string) {
for _, excludedlib := range ExcludedLibraries {
if filepath.Base(path) == excludedlib && *standalonePtr == false {
// log.Println("Skipping", excludedlib, "because it is on the excludelist")
return
}
}
// Find out whether there are pre-existing rpaths and if so, add them to libraryLocations
// so that we can find libraries there, too
// See if the library had a pre-existing rpath that did not start with $. If so, replace it by one that
// points to the equal location as the original but inside the AppDir
rpaths, err := readRpaths(path)
if err != nil {
helpers.PrintError("Could not determine rpath in "+path, err)
os.Exit(1)
}
for _, rpath := range rpaths {
rpath = filepath.Clean(strings.Replace(rpath, "$ORIGIN", filepath.Dir(path), -1))
if helpers.SliceContains(libraryLocations, rpath) == false && rpath != "" {
log.Println("Add", rpath, "to the libraryLocations directories we search for libraries")
libraryLocations = helpers.AppendIfMissing(libraryLocations, filepath.Clean(rpath))
}
}
libraryLocations = helpers.AppendIfMissing(libraryLocations, filepath.Clean(filepath.Dir(path)))
allELFs = helpers.AppendIfMissing(allELFs, path)
}
func determineELFsInDirTree(appdir helpers.AppDir, pathToDirTreeToBeDeployed string) {
allelfs, err := findAllExecutablesAndLibraries(pathToDirTreeToBeDeployed)
if err != nil {
helpers.PrintError("findAllExecutablesAndLibraries", err)
}
// Find the libraries determined by our ldd replacement and add them to
// allELFsUnderPath if they are not there yet
for _, lib := range allelfs {
appendLib(lib)
}
var allELFsUnderPath []ELF
for _, elfpath := range allelfs {
elfobj := ELF{}
elfobj.path = elfpath
allELFsUnderPath = append(allELFsUnderPath, elfobj)
err = getDeps(elfpath)
if err != nil {
helpers.PrintError("getDeps", err)
os.Exit(1)
}
}
log.Println("len(allELFsUnderPath):", len(allELFsUnderPath))
// Find out in which directories we now actually have libraries
log.Println("libraryLocations:", libraryLocations)
log.Println("len(allELFs):", len(allELFs))
}
func readRpaths(path string) ([]string, error) {
// Call patchelf to find out whether the ELF already has an rpath set
cmd := exec.Command("patchelf", "--print-rpath", path)
// log.Println("patchelf cmd.Args:", cmd.Args)
out, err := cmd.CombinedOutput()
if err != nil {
fmt.Println(cmd.String())
helpers.PrintError("patchelf --print-rpath "+path+": "+string(out), err)
os.Exit(1)
}
rpathStringInELF := strings.TrimSpace(string(out))
if rpathStringInELF == "" {
return []string{}, err
}
rpaths := strings.Split(rpathStringInELF, ":")
// log.Println("Determined", len(rpaths), "rpaths:", rpaths)
return rpaths, err
}
// findAllExecutablesAndLibraries returns all ELF libraries and executables
// found in directory, and error
func findAllExecutablesAndLibraries(path string) ([]string, error) {
var allExecutablesAndLibraries []string
// fmt.Println(" findAllExecutablesAndLibrarieschecking", path)
// If we have a file, then there is nothing to walk and we can return it directly
if helpers.IsDirectory(path) != true {
allExecutablesAndLibraries = append(allExecutablesAndLibraries, path)
return allExecutablesAndLibraries, nil
}
filepath.Walk(path, func(path string, info os.FileInfo, e error) error {
if e != nil {
return e
}
// Add ELF files
if info.Mode().IsRegular() {
f, err := os.Open(path)
defer f.Close()
if err == nil {
if helpers.CheckMagicAtOffset(f, "454c46", 1) == true {
allExecutablesAndLibraries = helpers.AppendIfMissing(allExecutablesAndLibraries, path)
}
}
}
return nil
})
return allExecutablesAndLibraries, nil
}
func getDeps(binaryOrLib string) error {
var libs []string
if helpers.Exists(binaryOrLib) == false {
return errors.New("binary does not exist: " + binaryOrLib)
}
e, err := elf.Open(binaryOrLib)
// log.Println("getDeps", binaryOrLib)
helpers.PrintError("elf.Open", err)
// ImportedLibraries returns the names of all libraries
// referred to by the binary f that are expected to be
// linked with the binary at dynamic link time.
libs, err = e.ImportedLibraries()
helpers.PrintError("e.ImportedLibraries", err)
for _, lib := range libs {
s, err := findLibrary(lib)
if err != nil {
return err
}
if helpers.SliceContains(allELFs, s) == true {
continue
} else {
libPath, err := findLibrary(lib)
helpers.PrintError("findLibrary", err)
appendLib(libPath)
err = getDeps(libPath)
helpers.PrintError("findLibrary", err)
}
}
return nil
}
func findWithPrefixInLibraryLocations(prefix string) ([]string, error) {
var found []string
// Try to find the file or directory in one of those locations
for _, libraryLocation := range libraryLocations {
found = helpers.FilesWithPrefixInDirectory(libraryLocation, prefix)
if len(found) > 0 {
return found, nil
}
}
return found, errors.New("did not find " + prefix)
}
// getDirsFromSoConf returns a []string with the directories specified
// in the ld config file at path, usually '/etc/ld.so.conf',
// and in its included config files. We need to search in those locations
// for libraries as well
func getDirsFromSoConf(path string) []string {
var out []string
f, err := os.Open(path)
if err != nil {
return nil
}
defer f.Close()
scanner := bufio.NewScanner(f)
for scanner.Scan() {
line := scanner.Text()
if strings.TrimSpace(line) == "" || strings.HasPrefix(line, "#") {
continue
} else if strings.HasPrefix(line, "include ") {
p := strings.Split(line, " ")[1]
files, err := filepath.Glob(p)
if err != nil {
return out
}
for _, file := range files {
out = append(out, getDirsFromSoConf(file)...)
}
continue
}
out = append(out, strings.TrimSpace(line))
}
return out
}
func findLibrary(filename string) (string, error) {
// Look for libraries in commonly used default locations
locs := []string{"/usr/lib64", "/lib64", "/usr/lib", "/lib",
"/usr/lib/x86_64-linux-gnu/libfakeroot",
"/usr/local/lib",
"/usr/local/lib/x86_64-linux-gnu",
"/lib/x86_64-linux-gnu",
"/usr/lib/x86_64-linux-gnu",
"/lib32",
"/usr/lib32"}
for _, loc := range locs {
libraryLocations = helpers.AppendIfMissing(libraryLocations, filepath.Clean(loc))
}
// Additionally, look for libraries in the same locations in which glibc ld.so looks for libraries
if helpers.Exists("/etc/ld.so.conf") {
locs := getDirsFromSoConf("/etc/ld.so.conf")
for _, loc := range locs {
libraryLocations = helpers.AppendIfMissing(libraryLocations, filepath.Clean(loc))
}
}
// Also look for libraries in in LD_LIBRARY_PATH
ldpstr := os.Getenv("LD_LIBRARY_PATH")
ldps := strings.Split(ldpstr, ":")
for _, ldp := range ldps {
if ldp != "" {
libraryLocations = helpers.AppendIfMissing(libraryLocations, filepath.Clean(ldp))
}
}
// TODO: find ld.so.cache on the system and use the locations contained therein, too
// Somewhere else in this code we are parsing each elf for pre-existing rpath/runpath and consider those locations as well
// Try to find the library in one of those locations
for _, libraryLocation := range libraryLocations {
if helpers.Exists(libraryLocation + "/" + filename) {
return libraryLocation + "/" + filename, nil
}
}
return "", errors.New("did not find library " + filename)
}
func NewLibrary(path string) ELF {
lib := ELF{}
lib.path = path
return lib
}
// PatchFile patches file by replacing 'search' with 'replace', returns error.
// TODO: Implement in-place replace like sed -i -e, without the need for an intermediary file
func PatchFile(path string, search string, replace string) error {
path = strings.TrimSpace(path) // Better safe than sorry
fi, err := os.Stat(path)
if err != nil {
return err
}
input, err := ioutil.ReadFile(path)
if err != nil {
return err
}
output := bytes.Replace(input, []byte(search), []byte(replace), -1)
if err = ioutil.WriteFile(path+".patched", output, fi.Mode().Perm()); err != nil {
return err
}
os.Rename(path+".patched", path)
return nil
}
func getCopyrightFile(path string) (string, error) {
var copyrightFile string
if helpers.IsCommandAvailable("dpkg") == false {
return copyrightFile, errors.New("dpkg not found, hence not deploying copyright files")
}
if helpers.IsCommandAvailable("dpkg-query") == false {
return copyrightFile, errors.New("dpkg-query not found, hence not deploying copyright files")
}
// Find out which package the file being deployed belongs to
var packageContainingTheSO string
pkg, ok := packagesContainingFiles[path]
if ok == true {
packageContainingTheSO = pkg
} else {
cmd := exec.Command("dpkg", "-S", path)
// log.Println("Find out which package the file being deployed belongs to using", cmd.String())
result, err := cmd.Output()
if err != nil {
return copyrightFile, err
}
parts := strings.Split(strings.TrimSpace(string(result)), ":")
packageContainingTheSO = parts[0]
}
// Find out the copyright file in that package
// We are caching the results so that multiple packages belonging to the same package have to run dpkg-query only once
// So first we check whether we already know it
cf, ok := copyrightFiles[packageContainingTheSO]
if ok == true {
return cf, nil
}
cmd := exec.Command("dpkg-query", "-L", packageContainingTheSO)
// log.Println("Find out the copyright file in that package using", cmd.String())
output, err := cmd.Output()
if err != nil {
return copyrightFile, err
}
lines := strings.Split(string(output), "\n")