wwine 0.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddfd32972c75b495e5bbbbe50ae199142e9f9d362602fca83f2c41264e894690
-  data.tar.gz: 8685c5b8731666a8ff21c263278c1714c78f9d71220d452241dcbb3a79365e8f
+  metadata.gz: 7894308cde683c0f748cb6d99aff493061300abc648b593d5b660b0ebe3a8df6
+  data.tar.gz: f93f04f10160712750868fb4f78499c0d1cd825fb741352265bc3b7a267b41f6
 SHA512:
-  metadata.gz: 684934489489f1d4cd122efe06c08b69a9733c556fb035b09f3d7a396b15744e8b6bace63820b24eee7cc55bd0feb034f26bf03d34cc6ef33a3bd467e76172a8
-  data.tar.gz: 2d10e6dcc66feb60791f0f45a720f93d3ecf1ec7fcfece501074512a746d873dd14512470f9730c1a66798d0d8bcb7e5de75672098e61c3d9f1b9c1febe2a5ef
+  metadata.gz: '068d62047e7c777409859e99758d372cfbf2be563956a88e738ee3f0aef2a103b1096686e2d9cd304e61fe12543bc22a13fd391d6fabb07607687af17ef1e9ed'
+  data.tar.gz: 840ac03026a7f696950d0c2f31fb8e07dcc55bd056d8ff65c1dcfb52d83335ffbaaa106e708fcf6a6f6d97b7406d6342cfe88e198d6ce6f878e66cf0279723c4

data/COPYING

@@ -1,12 +1,11 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
 
-		    GNU GENERAL PUBLIC LICENSE
-		       Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 
-			    Preamble
+                            Preamble
 
   The GNU General Public License is a free, copyleft license for
 software and other kinds of works.
@@ -69,7 +68,7 @@ patents cannot be used to render the program non-free.
   The precise terms and conditions for copying, distribution and
 modification follow.
 
-		       TERMS AND CONDITIONS
+                       TERMS AND CONDITIONS
 
   0. Definitions.
 
@@ -77,7 +76,7 @@ modification follow.
 
   "Copyright" also means copyright-like laws that apply to other kinds of
 works, such as semiconductor masks.
- 
+
   "The Program" refers to any copyrightable work licensed under this
 License.  Each licensee is addressed as "you".  "Licensees" and
 "recipients" may be individuals or organizations.
@@ -510,7 +509,7 @@ actual knowledge that, but for the patent license, your conveying the
 covered work in a country, or your recipient's use of the covered work
 in a country, would infringe one or more identifiable patents in that
 country that you have reason to believe are valid.
-  
+
   If, pursuant to or in connection with a single transaction or
 arrangement, you convey, or propagate by procuring conveyance of, a
 covered work, and grant a patent license to some of the parties
@@ -619,9 +618,9 @@ an absolute waiver of all civil liability in connection with the
 Program, unless a warranty or assumption of liability accompanies a
 copy of the Program in return for a fee.
 
-		     END OF TERMS AND CONDITIONS
+                     END OF TERMS AND CONDITIONS
 
-	    How to Apply These Terms to Your New Programs
+            How to Apply These Terms to Your New Programs
 
   If you develop a new program, and you want it to be of the greatest
 possible use to the public, the best way to achieve this is to make it
@@ -646,7 +645,7 @@ the "copyright" line and a pointer to where the full notice is found.
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 Also add information on how to contact you by electronic and paper mail.
 
@@ -665,12 +664,11 @@ might be different; for a GUI interface, you would use an "about box".
   You should also get your employer (if you work as a programmer) or school,
 if any, to sign a "copyright disclaimer" for the program, if necessary.
 For more information on this, and how to apply and follow the GNU GPL, see
-<http://www.gnu.org/licenses/>.
+<https://www.gnu.org/licenses/>.
 
   The GNU General Public License does not permit incorporating your program
 into proprietary programs.  If your program is a subroutine library, you
 may consider it more useful to permit linking proprietary applications with
 the library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.  But first, please read
-<http://www.gnu.org/philosophy/why-not-lgpl.html>.
-
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

data/README.md

@@ -0,0 +1,20 @@
+# wwine - a wrapper for wine
+
+wwine (wrapped wine) is a wrapper for the Windows compatibility layer
+[wine](http://www.winehq.com/). It wraps various flavours of wine into a
+single unified interface, complete with full bottle support for all of them.
+
+It integrates well with how the various flavours mange their bottles, so for
+instance applications isntalled using crossover will be manageable through the
+usual crossover interface.
+
+For vanilla wine, lutris and PlayOnLinux it uses WINEPREFIX to achieve bottle
+support, creating bottles as ~/.wwinebottles/[BOTTLE NAME]
+
+It supports the following flavours of wine:
+
+- [vanilla wine (winehq)](http://www.winehq.com/)
+- [wine-staging](https://github.com/wine-staging/wine-staging)
+- [Crossover](https://codeweavers.com/)
+- [wine from lutris](https://lutris.net/)
+- [wine from PlayOnLinux](https://www.playonlinux.com/en/)

data/wwine

@@ -19,8 +19,10 @@
 require 'getoptlong'
 # To read info for --debuginfo
 require 'open3'
+# Needed to make symlinks
+require 'fileutils'
 # Application version
-$version = '0.4'
+$version = '0.5'
 # The wine flavour to use
 $wine = nil
 # The bottle to use
@@ -58,8 +60,10 @@ def killWine (signal)
 	end
 	# Open a pipe to ps to read processes
 	wines = IO.popen('ps uxw')
-	# True if we have killed something
-	killed = false
+	# The result of our ps parsing
+	wineResult = []
+	# The length of the "wine" name, used to format the output well
+	wineLength = 10
 	# The name of the signal being sent
 	sigName = 'SIGTERM'
 	# Get an integer version of signal parameter
@@ -85,8 +89,6 @@ def killWine (signal)
 	if !dryRun
 		print 'Sending '+sigName+' to the following processes:'+"\n\n"
 	end
-	format = "%-10s %-12s %-8s %-20s\n"
-	printf(format,'Wine','Bottle','PID','Command')
 	# Go through each line in the 'ps' output
 	wines.each do |line|
 		# True if we *require* /proc to be read for this process.
@@ -149,19 +151,36 @@ def killWine (signal)
 		elsif $bottle && $bottle != extra['bottle']
 			next
 		end
+		resolvedWine = resolveWine(extra['wine'])
 		# Output information
-		printf(format,extra['wine'],extra['bottle'],pid,name)
+		wineResult.push({
+			'wine' => resolvedWine,
+			'bottle' => extra['bottle'],
+			'pid' => pid,
+			'name' => name
+		})
+
+		if resolvedWine.length > wineLength
+			wineLength = resolvedWine.length
+		end
+	end
+	# The format of the output
+	format = "%-"+wineLength.to_s+"s %-12s %-8s %-20s\n"
+	# Header
+	printf(format,'Wine','Bottle','PID','Command')
+	# Display or send signals to each entry
+	wineResult.each do |entry|
+		printf(format,entry['wine'],entry['bottle'],entry['pid'],entry['name'])
 		# Send SIGTERM (or output information if in dryRun mode)
 		if !dryRun
 			begin
-				Process.kill(signal,pid.to_i)
-			rescue 
-				puts('Error while attempting to send signal to '+pid+': '+$!)
+				Process.kill(signal,entry['pid'].to_i)
+			rescue
+				puts('Error while attempting to send signal to '+entry['pid']+': '+$!)
 			end
 		end
-		killed = true
 	end
-	if ! killed
+	if wineResult.length < 0
 		puts 'No wine processes found.'
 	end
 end
@@ -180,27 +199,32 @@ def getFromEnviron(path)
 			env[key] = value
 		end
 
-		if env['CX_BOTTLE']
-			info['bottle'] = env['CX_BOTTLE']
-		elsif env['WINEPREFIX']
-			info['bottle'] = File.basename(env['WINEPREFIX'])
-		elsif env['__WWINE_INT_XBOTTLE']
-			info['bottle'] = env['__WWINE_INT_XBOTTLE']
-		else
-			info['bottle'] = '(default)'
-		end
-		if env['CX_ROOT'] && env['CX_ROOT'].match(/cxoffice/)
+		if env['__WWINE_INT_XWINE']
+			info['wine'] = env['__WWINE_INT_XWINE']
+		elsif env['CX_ROOT'] && env['CX_ROOT'].match(/cxoffice/)
 			info['wine'] = 'crossover'
 		elsif env['CX_ROOT'] && env['CX_ROOT'].match(/cxgames/)
 			info['wine'] = 'cxgames'
-		elsif env['__WWINE_INT_XWINE']
-			info['wine'] = env['__WWINE_INT_XWINE']
+		elsif env['WINE']
+			info['wine'] = env['WINE']
 		elsif env['WINELOADER']
 			info['wine'] = 'wine'
 		elsif info['bottle'] == '.wine-pipelight'
 			info['wine'] = 'pipelight'
 			info['bottle'] = '(pipelight)'
 		end
+		if env['CX_BOTTLE']
+			info['bottle'] = env['CX_BOTTLE']
+		elsif env['__WWINE_INT_XBOTTLE']
+			info['bottle'] = env['__WWINE_INT_XBOTTLE']
+		elsif env['WINEPREFIX']
+			info['bottle'] = File.basename(env['WINEPREFIX'])
+			if info['bottle'] == 'pfx' && info['wine'] =~ /proton/i
+				info['bottle'] = File.basename(File.dirname(ENV['WINEPREFIX']))
+			end
+		else
+			info['bottle'] = '(default)'
+		end
 	end
 	return info
 end
@@ -360,6 +384,8 @@ def writeWrapper (targetFile, wwineCommand, otherCommand, cwd, wwineInfo, args,
 		file.puts("\t"+'export WINESERVER='+shellQuote(path+'/bin/wineserver'))
 		file.puts("\t"+'export WINELOADER='+shellQuote(path+'/bin/wine'))
 		file.puts("\t"+'export WINEDLLPATH='+shellQuote(path+'/lib/wine'))
+	elsif wwineInfo['Wine'] =~ /^proton/
+		file.puts("\t"+'export STEAM_COMPAT_DATA_PATH='+shellQuote(ENV['STEAM_COMPAT_DATA_PATH']))
 	elsif wwineInfo['Wine'] == 'wine' || wineprefix
 		if ENV['WINEDEBUG'] != nil
 			file.puts("\t"+"export WINEDEBUG="+shellQuote(ENV['WINEDEBUG']))
@@ -669,7 +695,7 @@ def parseWwineDataV1 (rawData)
 			info['Wine'] = info['Cxinstalldir']
 		end
 	end
-	
+
 	cmd = []
 
 	unquoteShellArray(rawData['Cmd'],cmd)
@@ -868,7 +894,7 @@ end
 def getCXVersionsFrom (source,wantString = false)
 	cxVer = nil
 	cxwVer = nil
-	if source != nil 
+	if source != nil
 		begin
 			# Store the binfile for use later
 			binFile = source[0]
@@ -1011,6 +1037,12 @@ def listWines(debug = false)
 			end
 		end
 
+		protons = getProtons()
+		protons.each do |entry,path|
+		  version = entry.sub(/^proton-/,'')
+		  printf(outFormat,'proton-'+version,getWineVersion(path+'/dist/bin/wine'))
+		end
+
 		if $wine != nil && debug
 			version = nil
 			if File.directory?($wine)
@@ -1044,7 +1076,7 @@ def handleException(ex)
 end
 
 # Purpose: Get parameters for wine
-def getWineWithParams (wine,bottle, missingIsFatal = true, playOnLinux = false)
+def getWineWithParams (wine,bottle, missingIsFatal = true, playOnLinux = false, proton = false)
 	final = []
 	possibleWines = []
 	if wine =~ /^wine(64|32|-unstable(32|64)?)$/
@@ -1326,6 +1358,100 @@ def getCustomwithParams(wine,bottle, type = 'POL', missingIsFatal = true, return
 	return getWineWithParams(detectedWine,bottle,missingIsFatal,polMode)
 end
 
+# Purpose: Get parameters for Proton
+def getProtonWithParams(wine,bottle, missingIsFatal = true)
+	command = []
+	protons = getProtons()
+	if !protons[wine]
+		if missingIsFatal
+			puts("Could not find a proton version matching \""+wine+"\"")
+			exit(1)
+		else
+			return nil
+		end
+	end
+
+	if bottle == nil
+		bottle = 'wwine-proton-default-bottle'
+	end
+
+	runtimeWrapper = ENV['HOME']+'/.steam/root/ubuntu12_32/steam-runtime/run.sh'
+
+	if ENV.has_key?('STEAM_RUNTIME') && ENV['STEAM_RUNTIME'] == "0"
+		vputs(V_DBG,"Skipping Steam runtime for proton because of the STEAM_RUNTIME env var")
+	elsif !File.exists?(runtimeWrapper)
+		vputs(V_DBG, "Did not find Steam runtime wrapper script, skipping steam runtime")
+	else
+		command.push(runtimeWrapper)
+	end
+
+	command.push( protons[wine]+'/proton','run')
+
+	bottleRoot = ENV['HOME']+'/.wwinebottles/'
+	if !File.exists?(bottleRoot)
+		vputs(V_INFO,bottleRoot+': does not exist, creating')
+		begin
+			Dir.mkdir(bottleRoot)
+		rescue SystemCallError
+			puts('Failed to create directory "'+bottleRoot+": "+$!)
+			puts('Unable to continue.')
+			exit(1)
+		end
+	end
+	if !File.exists?(bottleRoot+bottle)
+		vputs(V_INFO,bottleRoot+bottle+': does not exist, creating')
+		begin
+			Dir.mkdir(bottleRoot)
+		rescue SystemCallError
+			puts('Failed to create directory "'+bottleRoot+": "+$!)
+			puts('Unable to continue.')
+			exit(1)
+		end
+	end
+	# Proton always uses /pfx, we make that a symlink to the base bottle
+	if !File.exists?(bottleRoot+bottle+'/pfx')
+		FileUtils.ln_s(bottleRoot+bottle,bottleRoot+bottle+'/pfx')
+	end
+	# Proton uses STEAM_COMPAT_DATA_PATH to point to the bottle location
+	envPut('STEAM_COMPAT_DATA_PATH',bottleRoot+bottle)
+
+	# Disable wineArch support. Proton uses its own.
+	$wineArch = nil
+
+	vputs(V_DBG,'Detected proton: '+command.join(' '))
+	return command
+end
+
+# Purpose: Get a list of installed proton versions
+def getProtons ()
+	# Proton gets installed in the same "steam library" directory that the first game
+	# that used said version of Proton is installed to. Thus we need to parse out where
+	# all of Steam's library directories are to be able to produce a complete list.
+	dirs = [ ENV['HOME']+'/.steam/root/SteamApps/common' ]
+	steamConfigFile = ENV['HOME']+'/.steam/root/config/config.vdf'
+	if File.exists?(steamConfigFile)
+		source = File.open(steamConfigFile)
+		source.each("\n") do |entry|
+			if entry =~ /\s*\"BaseInstallFolder_\d+\"\s*/
+				dir = entry.sub(/^\s*\"BaseInstallFolder_\d+\"\s*\"(.*)\"/,'\1').chomp
+				dirs.push(dir+'/steamapps/common')
+			end
+		end
+	end
+	protons = {}
+	# Note: In the case of several identical proton versions we'll just use the last one
+	# we find
+	dirs.each do |entry|
+		Dir.glob(entry+'/Proton*') do |instance|
+			if File.executable?(instance+'/proton')
+				version = instance.sub(/.*Proton\s+(\d+\.\d+).*/,'\1')
+				protons['proton-'+version] = instance
+			end
+		end
+	end
+	return protons
+end
+
 # Purpose: Detect which wine to use and get parameters for that one
 # Returns: type,cmd
 def getAutoWithParams (bottle, missingIsFatal = true, returnFlavour = false)
@@ -1397,6 +1523,8 @@ def runWine (wine,bottle,args)
 		elsif wine =~ /^(pol|lutris)[-:]?/i
 			realWine = wine.sub(/^(pol|lutris)[-:]?/i,'')
 			cmd = getCustomwithParams(realWine,bottle,wine)
+		elsif wine =~ /^proton-/
+			cmd = getProtonWithParams(wine,bottle)
 		else
 			puts('Unknown --wine: '+wine)
 			if File.directory?(wine)
@@ -1515,6 +1643,10 @@ def resolveWine(wine)
 	if(map[wine])
 		wine = map[wine]
 	end
+	if wine =~ /\.local\/share\/lutris/
+		remapped = wine.sub!(/^.*\.local\/share\/lutris\/runners\/wine\/([^\/]+).*/,'\1')
+		return 'lutris-'+remapped
+	end
 	return wine
 end
 

data/wwine.1

@@ -1,5 +1,5 @@
 .IX Title "WWINE 1"
-.TH WWINE 1 "2018-04-21" "wwine 0.4" ""
+.TH WWINE 1 "2018-08-28" "wwine 0.5" ""
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
@@ -11,7 +11,7 @@ wwine \- a simple wine(1) wrapper
 wwine \fI(\s-1WWINE PARAMETERS\s0)\fR \fI\s-1PROGRAM\s0\fR \*(-- \fI[\s-1PROGRAM ARGUMENTS\s0]\fR
 .SH "DESCRIPTION"
 .IX Header "DESCRIPTION"
-\&\fBwwine\fR is a a \fIwine\fR\|(1) wrapper. It wraps various flavours of wine
+\&\fBwwine\fR is a a \fBwine\fR\|(1) wrapper. It wraps various flavours of wine
 (including vanilla wine and crossover) into a single
 unified interface, complete with full bottle support for all
 of them (including vanilla wine).
@@ -174,7 +174,7 @@ to enable wwine debugging output).
 .IX Item "--man"
 Show the manpage. Normally 'man wwine' would do, but when wwine is
 installed from a rubygem the wwine manpage isn't placed anywhere
-in \fIman\fR\|(1)'s path, this will autodetect its location and issue man
+in \fBman\fR\|(1)'s path, this will autodetect its location and issue man
 directly on the wwine.1 file (and thus work even when 'man wwine'
 does not).
 .IP "\fB\-\-debuginfo\fR" 4
@@ -247,6 +247,15 @@ Regular wine. <http://www.winehq.org/>
 .IX Item "Crossover and Crossover Office/Games"
 The commercial Crossover release from Codeweavers, as well as the legacy
 versions \*(L"Crossover Office\*(R" and \*(L"Crossover Games\*(R". <http://www.codeweavers.com/>
+.IP "\fBProton\fR (Steam Play)" 4
+.IX Item "Proton (Steam Play)"
+The wine version used by Steam Play to run Windows games in the native Steam
+client. Note that this does not obey \-\-winearch or \-\-debug, since proton uses
+its own builtin arch detection and debug method. <https://steampowered.com>
+and <https://github.com/ValveSoftware/Proton>.
+.IP "\fBLutris\fR" 4
+.IX Item "Lutris"
+Wine packages installed via Lutris. <https://lutris.net/>
 .IP "\fBPlayOnLinux\fR" 4
 .IX Item "PlayOnLinux"
 Wine packages installed via PlayOnLinux. <http://www.playonlinux.com/>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wwine
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: 0.5.0
 platform: ruby
 authors:
 - Eskild Hustvedt
 autorequire: 
 bindir: "."
 cert_chain: []
-date: 2018-04-21 00:00:00.000000000 Z
+date: 2018-08-28 00:00:00.000000000 Z
 dependencies: []
 description: wwine is a a wine(1) wrapper. It wraps various flavours of wine (including
   vanilla wine and crossover) into a single unified interface, complete with full
@@ -21,7 +21,7 @@ extra_rdoc_files: []
 files:
 - "./wwine"
 - COPYING
-- README
+- README.md
 - wwine
 - wwine.1
 homepage: http://random.zerodogg.org/wwine
@@ -44,7 +44,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: wwine is a simple wine wrapper.

data/README

@@ -1,11 +0,0 @@
-wwine (wrapped wine) is a a wine wrapper. It wraps various flavours of wine
-(including vanilla wine and crossover office/games) into a single
-unified interface, complete with full bottle support for all
-of them (including vanilla wine).
-
-It integrates well with all flavours, so for instance applications
-installed using crossover will be managable through the usual crossover
-interface.
-
-For vanilla wine it uses WINEPREFIX to achieve bottle support,
-creating bottles as ~/.wwinebottles/[BOTTLE_NAME]