jruby/core/src/main/java/org/jruby/util/ShellLauncher.java at master · jruby/jruby · GitHub

History

1664 lines (1457 loc) · 64.5 KB

Raw

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

/***** BEGIN LICENSE BLOCK *****

* Version: EPL 2.0/GPL 2.0/LGPL 2.1

* The contents of this file are subject to the Eclipse Public

* License Version 2.0 (the "License"); you may not use this file

* except in compliance with the License. You may obtain a copy of

* the License at http://www.eclipse.org/legal/epl-v20.html

* Software distributed under the License is distributed on an "AS

* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or

* implied. See the License for the specific language governing

* rights and limitations under the License.

* Alternatively, the contents of this file may be used under the terms of

* either of the GNU General Public License Version 2 or later (the "GPL"),

* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),

* in which case the provisions of the GPL or the LGPL are applicable instead

* of those above. If you wish to allow use of your version of this file only

* under the terms of either the GPL or the LGPL, and not to allow others to

* use your version of this file under the terms of the EPL, indicate your

* decision by deleting the provisions above and replace them with the notice

* and other provisions required by the GPL or the LGPL. If you do not delete

* the provisions above, a recipient may use your version of this file under

* the terms of any one of the EPL, the GPL or the LGPL.

***** END LICENSE BLOCK *****/

package org.jruby.util;

import static com.headius.backport9.buffer.Buffers.clearBuffer;

import static com.headius.backport9.buffer.Buffers.flipBuffer;

import static java.lang.System.out;

import static org.jruby.api.Access.objectClass;

import static org.jruby.api.Create.newHash;

import static org.jruby.api.Create.newString;

import static org.jruby.api.Error.argumentError;

import static org.jruby.api.Error.typeError;

import static org.jruby.api.Warn.warn;

import java.io.File;

import java.io.FileInputStream;

import java.io.FileOutputStream;

import java.io.IOException;

import java.io.InputStream;

import java.io.OutputStream;

import java.io.PipedInputStream;

import java.io.PipedOutputStream;

import java.io.PrintStream;

import java.lang.invoke.LambdaMetafactory;

import java.lang.invoke.MethodHandles;

import java.lang.invoke.MethodType;

import java.lang.reflect.Field;

import java.lang.reflect.Method;

import java.nio.ByteBuffer;

import java.nio.channels.FileChannel;

import java.util.ArrayList;

import java.util.Arrays;

import java.util.Collection;

import java.util.Collections;

import java.util.HashMap;

import java.util.List;

import java.util.Map;

import java.util.Set;

import java.util.regex.Matcher;

import java.util.regex.Pattern;

import org.jruby.main.Main;

import org.jruby.Ruby;

import org.jruby.RubyArray;

import org.jruby.RubyHash;

import org.jruby.RubyIO;

import org.jruby.RubyInstanceConfig;

import org.jruby.RubyModule;

import org.jruby.RubyString;

import jnr.posix.util.Platform;

import org.jruby.api.Access;

import org.jruby.ast.util.ArgsUtil;

import org.jruby.javasupport.Java;

import org.jruby.runtime.Helpers;

import org.jruby.ext.rbconfig.RbConfigLibrary;

import org.jruby.runtime.ThreadContext;

import org.jruby.runtime.builtin.IRubyObject;

import org.jruby.util.io.ChannelHelper;

import org.jruby.util.io.IOOptions;

import org.jruby.util.io.ModeFlags;

/**

* This mess of a class is what happens when all Java gives you is

* Runtime.getRuntime().exec(). Thanks dude, that really helped.

* @author nicksieger

@SuppressWarnings("deprecation")

public class ShellLauncher {

private static final boolean DEBUG = false;

private static final String PATH_ENV = "PATH";

// from MRI -- note the unixy file separators

private static final String[] DEFAULT_PATH =

{ "/usr/local/bin", "/usr/ucb", "/usr/bin", "/bin" };

private static final String[] WINDOWS_EXE_SUFFIXES =

{ ".exe", ".com", ".bat", ".cmd" }; // the order is important

private static final String[] WINDOWS_INTERNAL_CMDS = {

"assoc", "break", "call", "cd", "chcp",

"chdir", "cls", "color", "copy", "ctty", "date", "del", "dir", "echo", "endlocal",

"erase", "exit", "for", "ftype", "goto", "if", "lfnfor", "lh", "lock", "md", "mkdir",

"move", "path", "pause", "popd", "prompt", "pushd", "rd", "rem", "ren", "rename",

"rmdir", "set", "setlocal", "shift", "start", "time", "title", "truename", "type",

"unlock", "ver", "verify", "vol", };

// TODO: better check is needed, with quoting/escaping

private static final Pattern SHELL_METACHARACTER_PATTERN =

Pattern.compile("[*?{}\\[\\]<>()~&|$;'`\\\\\"\\n]");

private static final Pattern WIN_ENVVAR_PATTERN = Pattern.compile("%\\w+%");

private static class ScriptThreadProcess extends Process implements Runnable {

private final String[] argArray;

private final String[] env;

private final File pwd;

private final boolean pipedStreams;

private final PipedInputStream processOutput;

private final PipedInputStream processError;

private final PipedOutputStream processInput;

private RubyInstanceConfig config;

private Thread processThread;

private int result;

private final Ruby parentRuntime;

public ScriptThreadProcess(Ruby parentRuntime, final String[] argArray, final String[] env, final File dir) {

this(parentRuntime, argArray, env, dir, true);

}

public ScriptThreadProcess(Ruby parentRuntime, final String[] argArray, final String[] env, final File dir, final boolean pipedStreams) {

this.parentRuntime = parentRuntime;

this.argArray = argArray;

this.env = env;

this.pwd = dir;

this.pipedStreams = pipedStreams;

if (pipedStreams) {

processOutput = new PipedInputStream();

processError = new PipedInputStream();

processInput = new PipedOutputStream();

} else {

processOutput = processError = null;

processInput = null;

}

public void run() {

try {

this.result = (new Main(config).run(argArray)).getStatus();

} catch (Throwable throwable) {

throwable.printStackTrace(this.config.getError());

this.result = -1;

} finally {

this.config.getOutput().close();

this.config.getError().close();

try {this.config.getInput().close();} catch (IOException ioe) {}

}

private static Map<String, String> environmentMap(String[] env) {

Map<String, String> map = new HashMap<>(env.length + 2, 1);

for (int i = 0; i < env.length; i++) {

List<String> kv = StringSupport.split(env[i], '=', 2);

map.put(kv.get(0), kv.get(1));

}

return map;

}

public void start() throws IOException {

config = new RubyInstanceConfig(parentRuntime.getInstanceConfig());

config.setCurrentDirectory(pwd.toString());

config.setEnvironment(environmentMap(env));

if (pipedStreams) {

config.setInput(new PipedInputStream(processInput));

config.setOutput(new PrintStream(new PipedOutputStream(processOutput)));

config.setError(new PrintStream(new PipedOutputStream(processError)));

}

String procName = "piped";

if (argArray.length > 0) {

procName = argArray[0];

}

processThread = new Thread(this, "ScriptThreadProcess: " + procName);

processThread.setDaemon(true);

processThread.start();

}

public OutputStream getOutputStream() {

return processInput;

}

public InputStream getInputStream() {

return processOutput;

}

public InputStream getErrorStream() {

return processError;

}

public long pid() {

// no pid for a script so we return -1

return -1;

}

public int waitFor() throws InterruptedException {

processThread.join();

return result;

}

public int exitValue() {

return result;

}

public void destroy() {

if (pipedStreams) {

closeStreams();

}

processThread.interrupt();

}

private void closeStreams() {

try { processInput.close(); } catch (IOException io) {}

try { processOutput.close(); } catch (IOException io) {}

try { processError.close(); } catch (IOException io) {}

}

public static String[] getCurrentEnv(Ruby runtime) {

return getModifiedEnv(runtime, Collections.EMPTY_LIST, false);

}

private static String[] getCurrentEnv(Ruby runtime, Map mergeEnv) {

// TODO: ensure nobody passes null

return getModifiedEnv(runtime, mergeEnv == null ? Collections.EMPTY_LIST : mergeEnv.entrySet(), false);

}

@Deprecated(since = "10.0.0.0")

public static String[] getModifiedEnv(Ruby runtime, Collection mergeEnv, boolean clearEnv) {

return getModifiedEnv(runtime.getCurrentContext(), mergeEnv, clearEnv);

}

public static String[] getModifiedEnv(ThreadContext context, Collection mergeEnv, boolean clearEnv) {

// disable tracing for the dup call below

boolean traceEnabled = context.isEventHooksEnabled();

context.setEventHooksEnabled(false);

try {

// dup for JRUBY-6603 (avoid concurrent modification while we walk it)

RubyHash hash = clearEnv ? newHash(context) : (RubyHash) objectClass(context).getConstant(context, "ENV").dup();

if (mergeEnv != null) {

if (mergeEnv instanceof Set) {

for (Map.Entry e : (Set<Map.Entry>)mergeEnv) {

// if the key is nil, raise TypeError

Object key = e.getKey();

if (key == null) throw typeError(context, context.nil, "Struct");

// ignore if the value is nil

Object value = e.getValue();

if (value == null) {

hash.remove(key.toString());

continue;

}

hash.put(key.toString(), value.toString());

}

} else if (mergeEnv instanceof RubyArray) {

for (int j = 0; j < mergeEnv.size(); j++) {

RubyArray e = ((RubyArray)mergeEnv).eltOk(j).convertToArray();

// if there are not two elements, raise ArgumentError

if (e.size() != 2) throw argumentError(context, "env assignments must come in pairs");

// if the key is nil, raise TypeError

IRubyObject key = e.eltOk(0);

if (key == null || key.isNil()) throw typeError(context, context.nil, "Struct");

// ignore if the value is nil

IRubyObject value = e.eltOk(1);

if (value == null || value.isNil()) {

hash.remove(key.toString());

continue;

}

hash.put(key.toString(), value.toString());

}

String[] ret = new String[hash.size()];

int i = 0;

for (Map.Entry<String, String> e : (Set<Map.Entry<String, String>>)hash.entrySet()) {

// if the key is nil, raise TypeError

if (e.getKey() == null) throw typeError(context, context.nil, "Struct");

// ignore if the value is nil

if (e.getValue() == null) continue;

ret[i] = e.getKey() + '=' + e.getValue();

i++;

}

return arrayOfLength(ret, i);

} finally {

context.setEventHooksEnabled(traceEnabled);

}

private static String[] arrayOfLength(final String[] ary, final int len) {

return len == ary.length ? ary : Arrays.copyOf(ary, len);

}

private static boolean filenameIsPathSearchable(String fname, boolean forExec) {

if (fname.startsWith("/") ||

fname.startsWith("./") ||

fname.startsWith("../") ||

(forExec && (fname.indexOf('/') != -1))) {

return false;

}

if (Platform.IS_WINDOWS) {

if (fname.startsWith("\\") ||

fname.startsWith(".\\") ||

fname.startsWith("..\\") ||

((fname.length() > 2) && fname.charAt(1) == ':') ||

(forExec && (fname.indexOf('\\') != -1))) {

return false;

}

return true;

}

private static File tryFile(Ruby runtime, String fdir, String fname) {

File pathFile;

if (fdir == null) {

pathFile = new File(fname);

} else {

pathFile = new File(fdir, fname);

}

if (!pathFile.isAbsolute()) {

pathFile = new File(runtime.getCurrentDirectory(), pathFile.getPath());

}

log(runtime, "Trying file " + pathFile);

if (pathFile.exists()) return pathFile;

return null;

}

private static boolean withExeSuffix(String fname) {

String lowerCaseFname = fname.toLowerCase();

for (String suffix : WINDOWS_EXE_SUFFIXES) {

if (lowerCaseFname.endsWith(suffix)) {

return true;

}

return false;

}

private static File isValidFile(Ruby runtime, String fdir, String fname, boolean isExec) {

File validFile = null;

if (isExec && Platform.IS_WINDOWS) {

if (withExeSuffix(fname)) {

validFile = tryFile(runtime, fdir, fname);

} else {

for (String suffix: WINDOWS_EXE_SUFFIXES) {

validFile = tryFile(runtime, fdir, fname + suffix);

if (validFile != null) {

// found a valid file, no need to search further

break;

}

} else {

validFile = tryFile(runtime, fdir, fname);

if (validFile != null) {

if (validFile.isDirectory()) {

return null;

}

if (isExec && !runtime.getPosix().stat(validFile.getAbsolutePath()).isExecutable()) {

throw runtime.newErrnoEACCESError(validFile.getAbsolutePath());

}

return validFile;

}

private static File isValidFile(Ruby runtime, String fname, boolean isExec) {

String fdir = null;

return isValidFile(runtime, fdir, fname, isExec);

}

private static File findPathFile(Ruby runtime, String fname, String[] path, boolean isExec) {

File pathFile = null;

if (Platform.IS_WINDOWS && fname.startsWith("\"") && fname.endsWith("\"")) {

fname = fname.substring(1, fname.length() - 1); // remove double quotes if present

}

boolean doPathSearch = filenameIsPathSearchable(fname, isExec);

if (doPathSearch) {

for (String fdir: path) {

// NOTE: Jruby's handling of tildes is more complete than

// MRI's, which can't handle user names after the tilde

// when searching the executable path

try {

pathFile = isValidFile(runtime, fdir, fname, isExec);

if (pathFile != null) {

break;

}

} catch (SecurityException se) {

// Security prevented accessing this PATH entry, proceed to next

continue;

}

} else {

pathFile = isValidFile(runtime, fname, isExec);

}

return pathFile;

}

public static File findPathExecutable(Ruby runtime, String fname) {

ThreadContext context = runtime.getCurrentContext();

RubyHash env = (RubyHash) objectClass(context).getConstant(context, "ENV");

IRubyObject pathObject = env.op_aref(context, newString(context, PATH_ENV));

return findPathExecutable(context, fname, pathObject);

}

@Deprecated(since = "10.0.0.0")

public static File findPathExecutable(Ruby runtime, String fname, IRubyObject pathObject) {

return findPathExecutable(runtime.getCurrentContext(), fname, pathObject);

}

// MRI: Hopefully close to dln_find_exe_r used by popen logic

public static File findPathExecutable(ThreadContext context, String fname, IRubyObject pathObject) {

String[] pathNodes;

if (pathObject == null || pathObject.isNil()) {

RubyHash env = (RubyHash) objectClass(context).getConstant(context, "ENV");

pathObject = env.op_aref(context, newString(context, PATH_ENV));

}

if (pathObject.isNil() || pathObject.convertToString().size() == 0) {

pathNodes = DEFAULT_PATH; // ASSUME: not modified by callee

}

else {

String pathSeparator = System.getProperty("path.separator");

String path = pathObject.toString();

if (Platform.IS_WINDOWS) {

// Windows-specific behavior

path = "." + pathSeparator + path;

}

pathNodes = path.split(pathSeparator);

}

return findPathFile(context.runtime, fname, pathNodes, true);

}

public static int runAndWait(Ruby runtime, IRubyObject[] rawArgs) {

return runAndWait(runtime, rawArgs, runtime.getOutputStream());

}

public static long[] runAndWaitPid(Ruby runtime, IRubyObject[] rawArgs) {

return runAndWaitPid(runtime, rawArgs, runtime.getOutputStream(), true);

}

public static long runWithoutWait(Ruby runtime, IRubyObject[] rawArgs) {

return runWithoutWait(runtime, rawArgs, runtime.getOutputStream());

}

public static int runExternalAndWait(Ruby runtime, IRubyObject[] rawArgs, Map mergeEnv) {

OutputStream output = runtime.getOutputStream();

OutputStream error = runtime.getErrorStream();

InputStream input = runtime.getInputStream();

File pwd = new File(runtime.getCurrentDirectory());

LaunchConfig cfg = new LaunchConfig(runtime, rawArgs, true);

try {

Process process;

try {

if (cfg.shouldRunInShell()) {

log(runtime, "Launching with shell");

// execute command with sh -c ... this does shell expansion of wildcards

cfg.verifyExecutableForShell();

} else {

log(runtime, "Launching directly (no shell)");

cfg.verifyExecutableForDirect();

}

final String[] execArgs = cfg.getExecArgs();

if (changeDirInsideJar(runtime, execArgs)) {

pwd = new File(System.getProperty("user.dir"));

}

process = buildProcess(runtime, execArgs, getCurrentEnv(runtime, mergeEnv), pwd);

} catch (SecurityException se) {

throw runtime.newSecurityError(se.getLocalizedMessage());

}

handleStreams(runtime, process, input, output, error);

return process.waitFor();

} catch (IOException e) {

throw runtime.newIOErrorFromException(e);

} catch (InterruptedException e) {

throw runtime.newThreadError("unexpected interrupt");

}

public static long runExternalWithoutWait(Ruby runtime, IRubyObject env, IRubyObject prog, IRubyObject options, IRubyObject args) {

return runExternal(runtime, env, prog, options, args, false);

}

public static long runExternal(Ruby runtime, IRubyObject env, IRubyObject prog, IRubyObject options, IRubyObject args, boolean wait) {

if (env.isNil() || !(env instanceof Map)) {

env = null;

}

IRubyObject[] rawArgs = args.convertToArray().toJavaArray(runtime.getCurrentContext());

OutputStream output = runtime.getOutputStream();

OutputStream error = runtime.getErrorStream();

InputStream input = runtime.getInputStream();

File pwd = new File(runtime.getCurrentDirectory());

LaunchConfig cfg = new LaunchConfig(runtime, rawArgs, true);

try {

Process process;

try {

if (cfg.shouldRunInShell()) {

log(runtime, "Launching with shell");

// execute command with sh -c

// this does shell expansion of wildcards

cfg.verifyExecutableForShell();

} else {

log(runtime, "Launching directly (no shell)");

cfg.verifyExecutableForDirect();

}

final String[] execArgs = cfg.getExecArgs();

if (changeDirInsideJar(runtime, execArgs)) {

pwd = new File(".");

}

process = buildProcess(runtime, execArgs, getCurrentEnv(runtime, (Map) env), pwd);

} catch (SecurityException se) {

throw runtime.newSecurityError(se.getLocalizedMessage());

}

if (wait) {

handleStreams(runtime, process, input, output, error);

try {

return process.waitFor();

} catch (InterruptedException e) {

throw runtime.newThreadError("unexpected interrupt");

}

} else {

handleStreamsNonblocking(runtime, process, runtime.getOutputStream(), error);

return getPidFromProcess(process);

}

} catch (IOException e) {

throw runtime.newIOErrorFromException(e);

}

private static boolean changeDirInsideJar(final Ruby runtime, final String[] args) {

final String arg;

if ((arg = changeDirInsideJar(runtime, args[args.length - 1])) != null) {

args[args.length - 1] = arg;

return true;

}

return false;

}

public static String changeDirInsideJar(final Ruby runtime, final String arg) {

// only if inside a jar and spawning org.jruby.main.Main we change to the current directory inside the jar

if (runtime.getCurrentDirectory().startsWith("uri:classloader:") && arg.contains("org.jruby.main.Main")) {

return StringSupport.replaceFirst(arg, "org.jruby.main.Main", "org.jruby.main.Main -C " + runtime.getCurrentDirectory()).toString();

}

return null;

}

public static Process buildProcess(Ruby runtime, String[] args, String[] env, File pwd) throws IOException {

return runtime.getPosix().newProcessMaker(args)

.environment(env)

.directory(pwd)

.start();

}

public static long runExternalWithoutWait(Ruby runtime, IRubyObject[] rawArgs) {

return runWithoutWait(runtime, rawArgs, runtime.getOutputStream());

}

public static int execAndWait(Ruby runtime, IRubyObject[] rawArgs) {

return execAndWait(runtime, rawArgs, Collections.EMPTY_MAP);

}

public static int execAndWait(Ruby runtime, IRubyObject[] rawArgs, Map mergeEnv) {

File pwd = new File(runtime.getCurrentDirectory());

LaunchConfig cfg = new LaunchConfig(runtime, rawArgs, true);

if (cfg.shouldRunInProcess()) {

log(runtime, "ExecAndWait in-process");

try {

// exec needs to behave differently in-process, because it's technically

// supposed to replace the calling process. So if we're supposed to run

// in-process, we allow it to use the default streams and not use

// pumpers at all. See JRUBY-2156 and JRUBY-2154.

ScriptThreadProcess ipScript = new ScriptThreadProcess(

runtime, cfg.getExecArgs(), getCurrentEnv(runtime, mergeEnv), pwd, false);

ipScript.start();

return ipScript.waitFor();

} catch (IOException e) {

throw runtime.newIOErrorFromException(e);

} catch (InterruptedException e) {

throw runtime.newThreadError("unexpected interrupt");

}

} else {

return runExternalAndWait(runtime, rawArgs, mergeEnv);

}

public static int runAndWait(Ruby runtime, IRubyObject[] rawArgs, OutputStream output) {

return runAndWait(runtime, rawArgs, output, true);

}

public static int runAndWait(Ruby runtime, IRubyObject[] rawArgs, OutputStream output, boolean doExecutableSearch) {

return (int)runAndWaitPid(runtime, rawArgs, output, doExecutableSearch)[0];

}

public static long[] runAndWaitPid(Ruby runtime, IRubyObject[] rawArgs, OutputStream output, boolean doExecutableSearch) {

OutputStream error = runtime.getErrorStream();

InputStream input = runtime.getInputStream();

try {

Process aProcess = run(runtime, rawArgs, doExecutableSearch);

handleStreams(runtime, aProcess, input, output, error);

return new long[] {aProcess.waitFor(), getPidFromProcess(aProcess)};

} catch (IOException e) {

throw runtime.newIOErrorFromException(e);

} catch (InterruptedException e) {

throw runtime.newThreadError("unexpected interrupt");

}

private static long runWithoutWait(Ruby runtime, IRubyObject[] rawArgs, OutputStream output) {

OutputStream error = runtime.getErrorStream();

try {

Process aProcess = run(runtime, rawArgs, true);

handleStreamsNonblocking(runtime, aProcess, output, error);

return getPidFromProcess(aProcess);

} catch (IOException e) {

throw runtime.newIOErrorFromException(e);

}

public static long getPidFromProcess(Process process) {

if (process instanceof ScriptThreadProcess) {

return process.hashCode();

} else if (process instanceof POpenProcess) {

return reflectPidFromProcess(((POpenProcess)process).getChild());

} else {

return reflectPidFromProcess(process);

}

private static final Class UNIXProcess;

private static final Field UNIXProcess_pid;

private static final Class ProcessImpl;

private static final Field ProcessImpl_handle;

private static final Method ProcessImpl_pid;

private interface PidGetter { long getPid(Process process); }

private static final PidGetter PID_GETTER;

static {

PidGetter pidGetter = null;

// try Java 9+ pid access:

try {

Method pid = Process.class.getMethod("pid");

pidGetter = (PidGetter) LambdaMetafactory.altMetafactory(

MethodHandles.lookup(),

"getPid",

MethodType.methodType(PidGetter.class),

MethodType.methodType(long.class, Process.class),

MethodHandles.lookup().unreflect(pid),

MethodType.methodType(long.class, Process.class),

.dynamicInvoker().invoke();

} catch (Throwable t) {

// fall through to other options

}

// try reflective access to process internals

Class up = null;

Field pid = null;

Class pi = null;

Field handle = null;

Method pi_pid = null;

if (pidGetter == null) {

try {

up = Class.forName("java.lang.UNIXProcess");

} catch (ClassNotFoundException e) {

try {

// Renamed in 11 (or earlier)

up = Class.forName("java.lang.ProcessImpl");

} catch (ClassNotFoundException e2) {

// ignore and try windows version

}

if (up != null) {

try {

pid = up.getDeclaredField("pid");

if (!Java.trySetAccessible(pid)) pid = null;

} catch (NoSuchFieldException | SecurityException e) {

// ignore and try windows version

}

try {

pi = Class.forName("java.lang.ProcessImpl");

handle = pi.getDeclaredField("handle");

if (!Java.trySetAccessible(handle)) {

handle = null;

}

} catch (Exception e) {

// ignore and use hashcode

}

if (pi != null) {

try {

pi_pid = pi.getMethod("pid");

if (!Java.trySetAccessible(pi_pid)) {

pi_pid = null;

if (handle == null) pi = null;

}

} catch (Exception e) {

// ignore and use hashcode

}

if (pid != null) {

if (handle != null) {

// try both

pidGetter = ShellLauncher::getPidBoth;

} else {

// just unix

pidGetter = ShellLauncher::getPidUnix;

}

} else if (handle != null || pi_pid != null) {

// just windows

pidGetter = ShellLauncher::getPidWindows;

} else {

// neither - default PidGetter

pidGetter = Object::hashCode;

}

UNIXProcess = up;

UNIXProcess_pid = pid;

ProcessImpl = pi;

ProcessImpl_handle = handle;

ProcessImpl_pid = pi_pid;

PID_GETTER = pidGetter;

}

public static long reflectPidFromProcess(Process process) {

return PID_GETTER.getPid(process);

}

private static long getPidBoth(Process process) {

try {

if (UNIXProcess.isInstance(process)) {

return getPidUnix(process);

} else if (ProcessImpl.isInstance(process)) {

return getPidWindows(process);

}

} catch (Exception e) {

// fall back on hashcode

}

return process.hashCode();

}

private static long getPidWindows(Process process) {

long pid = -1;

if (ProcessImpl_handle != null) {

try {

if (ProcessImpl.isInstance(process)) {

Long hproc = (Long) ProcessImpl_handle.get(process);

return WindowsFFI.getKernel32().GetProcessId(hproc);

}

} catch (Exception e) {

// fall back on pid logic

}

if (pid == -1 && ProcessImpl_pid != null) {

// JDK > 8 has a new way to look it up and also can't use "handle" field anymore

try {

return (long) ProcessImpl_pid.invoke(process);

} catch (Exception e2) {

// fall back on hashcode

}

return process.hashCode();

}

private static long getPidUnix(Process process) {

try {

if (UNIXProcess.isInstance(process)) {

return (Integer) UNIXProcess_pid.get(process);

}

} catch (Exception e) {

// fall back on hashcode

}

return process.hashCode();

}

public static Process run(Ruby runtime, IRubyObject string) throws IOException {

return run(runtime, new IRubyObject[] {string}, false);

}

public static POpenProcess popen(Ruby runtime, IRubyObject string, ModeFlags modes) throws IOException {

return new POpenProcess(popenShared(runtime, new IRubyObject[] {string}, null, true), runtime, modes);

}

public static POpenProcess popen(Ruby runtime, IRubyObject[] strings, Map env, ModeFlags modes) throws IOException {

return new POpenProcess(popenShared(runtime, strings, env), runtime, modes);

}

public static POpenProcess popen(Ruby runtime, IRubyObject string, Map env, ModeFlags modes) throws IOException {

return new POpenProcess(popenShared(runtime, new IRubyObject[] {string}, env, true), runtime, modes);

}

private static Process popenShared(Ruby runtime, IRubyObject[] strings) throws IOException {

return popenShared(runtime, strings, null);

}

private static Process popenShared(Ruby runtime, IRubyObject[] strings, Map env) throws IOException {

return popenShared(runtime, strings, env, false);

}

private static Process popenShared(Ruby runtime, IRubyObject[] strings, Map env, boolean addShell) throws IOException {

var context = runtime.getCurrentContext();

String shell = getShell(runtime);

File pwd = new File(runtime.getCurrentDirectory());

try {

// Peel off env hash, if given

IRubyObject envHash;

if (env == null && strings.length > 0 && !(envHash = TypeConverter.checkHashType(runtime, strings[0])).isNil()) {

strings = Arrays.copyOfRange(strings, 1, strings.length);

env = (Map) envHash;

}

// Peel off options hash and warn that we don't support them

if (strings.length > 1 && !(envHash = TypeConverter.checkHashType(runtime, strings[strings.length - 1])).isNil()) {

if (!((RubyHash)envHash).isEmpty()) warn(context, "popen3 does not support spawn options in JRuby 1.7");

strings = Arrays.copyOfRange(strings, 0, strings.length - 1);

}

String[] args = parseCommandLine(context, runtime, strings);

LaunchConfig cfg = new LaunchConfig(runtime, strings, true);

boolean useShell = Platform.IS_WINDOWS ? cfg.shouldRunInShell() : false;

if (addShell) for (String arg : args) useShell |= shouldUseShell(arg);

if (useShell) {

cfg.verifyExecutableForShell();

} else {

cfg.verifyExecutableForDirect();

}

return buildProcess(runtime, cfg.execArgs, getCurrentEnv(runtime, env), pwd);

} catch (SecurityException se) {

throw runtime.newSecurityError(se.getLocalizedMessage());

}

public static class POpenProcess extends Process {

private final Process child;

private final boolean waitForChild;

// real stream references, to keep them from being GCed prematurely

private InputStream realInput;

private OutputStream realOutput;

private InputStream realInerr;

private InputStream input;

private OutputStream output;

private InputStream inerr;

private FileChannel inputChannel;

private FileChannel outputChannel;

private FileChannel inerrChannel;

private Pumper inputPumper;

private Pumper inerrPumper;

public POpenProcess(Process child, Ruby runtime, ModeFlags modes) {

this.child = child;

if (modes.isWritable()) {

this.waitForChild = true;

prepareOutput(child);

} else {

this.waitForChild = false;

// close process output

// See JRUBY-3405; hooking up to parent process stdin caused

// problems for IRB etc using stdin.

try {child.getOutputStream().close();} catch (IOException ioe) {}

}

if (modes.isReadable()) {

prepareInput(child);

} else {

pumpInput(child, runtime);

}

pumpInerr(child, runtime);

}

public POpenProcess(Process child) {

this.child = child;

this.waitForChild = false;

prepareOutput(child);

prepareInput(child);

prepareInerr(child);

}

@Override

public OutputStream getOutputStream() {

return output;

}

@Override

public InputStream getInputStream() {

return input;

}

@Override

public InputStream getErrorStream() {

return inerr;

}

public FileChannel getInput() {

return inputChannel;

}

public FileChannel getOutput() {

return outputChannel;

}

public long pid() {

return PID_GETTER.getPid(child);

}

public FileChannel getError() {

return inerrChannel;

}

public boolean hasOutput() {

return output != null || outputChannel != null;

}

public Process getChild() {

return child;

}

@Override

public int waitFor() throws InterruptedException {

return child.waitFor();

}

@Override

public int exitValue() {

return child.exitValue();

}

@Override

public void destroy() {

try {

// We try to safely close all streams and channels to the greatest

// extent possible.

try {if (input != null) input.close();} catch (Exception e) {}

try {if (inerr != null) inerr.close();} catch (Exception e) {}

try {if (output != null) output.close();} catch (Exception e) {}

try {if (inputChannel != null) inputChannel.close();} catch (Exception e) {}

try {if (inerrChannel != null) inerrChannel.close();} catch (Exception e) {}

try {if (outputChannel != null) outputChannel.close();} catch (Exception e) {}

// processes seem to have some peculiar locking sequences, so we

View remainder of file in raw view

jruby/core/src/main/java/org/jruby/util/ShellLauncher.java at master · jruby/jruby · GitHub

Uh oh!

Uh oh!

jruby/core/src/main/java/org/jruby/util/ShellLauncher.java at master · jruby/jruby · GitHub

Uh oh!

Uh oh!

Expand file tree

Breadcrumbs

ShellLauncher.java

Latest commit

History

Breadcrumbs

ShellLauncher.java

File metadata and controls