This file is indexed.

/usr/bin/freefoam-job is in freefoam 0.1.0+dfsg+1-3.

This file is owned by root:root, with mode 0o755.

The actual contents of the file can be viewed below.

  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
#! /usr/bin/python
#-------------------------------------------------------------------------------
#               ______                _     ____          __  __
#              |  ____|             _| |_  / __ \   /\   |  \/  |
#              | |__ _ __ ___  ___ /     \| |  | | /  \  | \  / |
#              |  __| '__/ _ \/ _ ( (| |) ) |  | |/ /\ \ | |\/| |
#              | |  | | |  __/  __/\_   _/| |__| / ____ \| |  | |
#              |_|  |_|  \___|\___|  |_|   \____/_/    \_\_|  |_|
#
#                   FreeFOAM: The Cross-Platform CFD Toolkit
#
# Copyright (C) 2008-2012 Michael Wild <themiwi@users.sf.net>
#                         Gerber van der Graaf <gerber_graaf@users.sf.net>
#-------------------------------------------------------------------------------
# License
#   This file is part of FreeFOAM.
#
#   FreeFOAM is free software: you can redistribute it and/or modify it
#   under the terms of the GNU General Public License as published by the
#   Free Software Foundation, either version 3 of the License, or (at your
#   option) any later version.
#
#   FreeFOAM is distributed in the hope that it will be useful, but WITHOUT
#   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
#   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
#   for more details.
#
#   You should have received a copy of the GNU General Public License
#   along with FreeFOAM.  If not, see <http://www.gnu.org/licenses/>.
#
# Script
#     freefoam-job
#
# Description
#     Run a freefoam job in background and redirect the output to a log-file.
#
#------------------------------------------------------------------------------

"""Usage: freefoam job [-s] [-p] [-log <logfile>] [-fg]
                          [-h, -help] <application> [OPTIONS]

Run a freefoam job in background and redirect the output to a log-file.

Options
-------
-s             Also send output to the terminal
-p             Parallel run of processors
-log <logfile> Specify logfile name for output, defaults to 'log'
-fg            Run the job in the foreground (i.e. don't background it)
-h, -help      Display this help message
<application>  The FreeFOAM application to run
[OPTIONS]      Arguments and options to be passed to the application

"""

import FreeFOAM.util
import FreeFOAM.run
import os
import sys
import subprocess
# want to be future proof
sys.path.insert(0, '/usr/lib/python2.7/site-packages')
from FreeFOAM.compat import *

# parse options
screen = False
parallel = False
logName = 'log'
foreground = False
application = None
args = sys.argv[1:]
while len(args) > 0:
   a = args[0]
   if a == '-s':
      screen = True
      del args[0]
   elif a == '-p':
      parallel = True
      del args[0]
   elif a == '-log':
      if len(args) < 2:
         sys.stderr.write('Error: The -log option requires an argument\n')
         sys.exit(1)
      logName = args[1]
      del args[0:2]
   elif a == '-fg':
      foreground = True
      del args[0]
   elif a == '-h' or a == '-help':
      print(__doc__)
      sys.exit(0)
   elif a[0] == '-':
      sys.stderr.write('Error: unknown option "%s"\n'%a)
      sys.stderr.write(__doc__+'\n')
      sys.exit(1)
   else:
      application = a
      del args[0]
      break

if not application:
   sys.stderr.write("Error: No application specified")
   sys.stderr.write(__doc__+'\n')
   sys.exit(1)

# now look for the -case option in the remaining arguments
case = '.'
for i, a in enumerate(args):
   if a == '-case':
      case = args[i+1]
      del args[i:i+2]
      break

# if we are to run in the background, fork (MUST BE FIRST!)
if not foreground:
   pid = os.fork()
   if pid:
      # this is the parent process
      sys.exit(0)

# this is the child process continuing here (if we forked)

# create the log file
if screen:
   logFile = FreeFOAM.util.Tee(logName, 'wt')
else:
   logFile = open(logName, 'wt')

# create the runner instance
if parallel:
   runner = FreeFOAM.run.ParallelRunner()
else:
   runner = FreeFOAM.run.Runner()

# run the thing (needs a bit of hackery...)
runner.run(application, case=case, parallel=parallel, args=args,
      stdout=subprocess.PIPE, stderr=subprocess.STDOUT, background=True)

# retrieve the output and write it to the log file as long as the thing runs
while True:
   lines = runner.getProcess().stdout.readlines()
   if len(lines) and not isinstance(lines[0], str):
      lines = list(map(lambda l: l.decode(), lines))
   logFile.writelines(lines)
   returncode = runner.poll()
   if returncode != None:
      break

sys.exit(returncode)

# ------------------- vim: set sw=3 sts=3 ft=python et: ------------ end-of-file