coldbox-platform/system/Bootstrap.cfc at development · ColdBox/coldbox-platform · GitHub

History

836 lines (754 loc) · 28.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

/**

* Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp

* www.ortussolutions.com

* ---

* Loads the framwork into memory and provides a ColdBox application.

* @author Luis Majano <lmajano@ortussolutions.com>

component serializable="false" accessors="true" {

/************************************** CONSTRUCTOR *********************************************/

// Configuration File Override

property name="COLDBOX_CONFIG_FILE";

// Application root disk path

property name="COLDBOX_APP_ROOT_PATH";

// The key used in application scope to model this app

property name="COLDBOX_APP_KEY";

// The application mapping where the CFML assets are located

property name="COLDBOX_APP_MAPPING";

// The web mapping where the web root is located, usually this is empty unless in a subdirectory

property name="COLDBOX_WEB_MAPPING";

// Lock Timeout for startup operations

property name="lockTimeout";

// The application hash used for locks

property name="appHash" default="#getBaseTemplatePath()#";

// By default if an app is reiniting and a request hits it, we will fail fast with a message

property name="COLDBOX_FAIL_FAST";

// param the properties with defaults

param name="COLDBOX_CONFIG_FILE" default="";

param name="COLDBOX_APP_ROOT_PATH" default="#getDirectoryFromPath( getBaseTemplatePath() )#";

param name="COLDBOX_APP_KEY" default="cbController";

param name="COLDBOX_APP_MAPPING" default="";

param name="COLDBOX_WEB_MAPPING" default="";

param name="lockTimeout" default="30" type="numeric";

param name="COLDBOX_FAIL_FAST" default="true";

/**

* Constructor, called by your Application CFC

* @COLDBOX_CONFIG_FILE The override location of the config file

* @COLDBOX_APP_ROOT_PATH The location of the app on disk

* @COLDBOX_APP_KEY The key used in application scope for this application

* @COLDBOX_APP_MAPPING The application mapping where the CFML assets are located

* @COLDBOX_FAIL_FAST By default if an app is reiniting and a request hits it, we will fail fast with a message. This can be a boolean indicator or a closure.

* @COLDBOX_WEB_MAPPING The web mapping where the web root is located, usually this is empty unless in a subdirectory

Bootstrap function init(

required string COLDBOX_CONFIG_FILE,

required string COLDBOX_APP_ROOT_PATH,

string COLDBOX_APP_KEY,

string COLDBOX_APP_MAPPING = "",

any COLDBOX_FAIL_FAST = true,

string COLDBOX_WEB_MAPPING = ""

){

variables.COLDBOX_CONFIG_FILE = arguments.COLDBOX_CONFIG_FILE

variables.COLDBOX_APP_ROOT_PATH = arguments.COLDBOX_APP_ROOT_PATH

variables.COLDBOX_APP_MAPPING = arguments.COLDBOX_APP_MAPPING

variables.COLDBOX_WEB_MAPPING = arguments.COLDBOX_WEB_MAPPING

variables.COLDBOX_FAIL_FAST = arguments.COLDBOX_FAIL_FAST

// App Key Check

if ( structKeyExists( arguments, "COLDBOX_APP_KEY" ) AND len( trim( arguments.COLDBOX_APP_KEY ) ) ) {

variables.COLDBOX_APP_KEY = arguments.COLDBOX_APP_KEY

}

return this

}

/**

* Loads the framework into application scope and executes app start procedures

* @throws InvalidColdBoxMapping

function loadColdBox(){

var appKey = locateAppKey()

var startTime = getTickCount()

// Param the incoming app hash

variables.appHash = "#hash( getBaseTemplatePath() & application.applicationname )#";

// Cleanup of old code, just in case

if ( structKeyExists( application, appKey ) ) {

structDelete( application, appKey )

}

// Verify Mapping

if ( !directoryExists( expandPath( "/coldbox/system/" ) ) ) {

throw(

message = "Cannot find the '/'coldbox' mapping or directory",

detail = "It seems that you do not have a '/coldbox' mapping in your application and we cannot continue to process the request.

Make sure ColdBox is installed correctly or create a mapping to the ColdBox system folder.",

type = "InvalidColdBoxMapping"

)

}

// Create Brand New Controller

application[ appKey ] = new coldbox.system.web.Controller( variables.COLDBOX_APP_ROOT_PATH, appKey )

// Setup the Framework And Application

application[ appKey ]

.getLoaderService()

.loadApplication(

variables.COLDBOX_CONFIG_FILE,

variables.COLDBOX_APP_MAPPING,

variables.COLDBOX_WEB_MAPPING

)

// Get the reinit key

// Application Start Handler

try {

if ( len( application[ appKey ].getSetting( "ApplicationStartHandler" ) ) ) {

application[ appKey ].runEvent(

event = application[ appKey ].getSetting( "ApplicationStartHandler" )

)

}

} catch ( any e ) {

// process the exception

writeOutput( processException( application[ appKey ], e ) )

// abort it, something went really wrong.

abort;

}

// Check if fwreinit is sent, if sent, ignore it, we are loading the framework

var reinitKey = application[ appKey ].getSetting( "reinitKey", "fwreinit" )

if ( structKeyExists( url, reinitKey ) ) {

structDelete( url, reinitKey )

}

// Log startup time

var elapsedMs = getTickCount() - startTime

application[ appKey ]

.getLogBox()

.getLogger( this )

.info( "=> ColdBox Application started in [#elapsedMs#] ms" );

return this

}

/**

* Request Reload procedures

function reloadChecks(){

var appKey = locateAppKey();

var needReinit = isfwReinit();

// Initialize the Controller If Needed, double locked

if (

NOT structKeyExists( application, appkey ) OR NOT application[ appKey ].getColdboxInitiated() OR needReinit

) {

lock type="exclusive" name="#appHash#" timeout="#lockTimeout#" throwontimeout="true" {

// double lock

if (

NOT structKeyExists( application, appkey ) OR NOT application[ appKey ].getColdboxInitiated() OR needReinit

) {

try {

// Tell the word we are reiniting

application.fwReinit = true;

// Verify if we are Reiniting?

if (

structKeyExists( application, appKey ) AND application[ appKey ].getColdboxInitiated() AND needReinit

) {

// Load Module Engine Mappings so modules can unload properly

application[ appKey ].getModuleService().loadMappings();

// process preReinit interceptors

application[ appKey ].getInterceptorService().announce( "preReinit" );

// Shutdown the application services

application[ appKey ].getLoaderService().processShutdown( force = true );

}

// Reload ColdBox

loadColdBox();

// Remove any context stragglers and reloading bit

structDelete( request, "cb_requestContext" );

application.fwReinit = false;

} catch ( any e ) {

// Added here as ACF does not execute the finally block on some ocassions. Impossible to reproduce.

application.fwReinit = false;

// Something went really wrong, clear everything out

structDelete( application, appKey );

structDelete( application, "wirebox" );

structDelete( request, "cb_requestContext" );

rethrow;

} finally {

application.fwReinit = false;

structDelete( request, "cb_requestContext" );

}

// end lock

}

try {

// Get Controller Reference

var cbController = application[ appKey ];

// WireBox Singleton AutoReload

if ( cbController.getSetting( "Wirebox" ).singletonReload ) {

lock type="exclusive" name="#appHash#" timeout="#lockTimeout#" throwontimeout="true" {

cbController.getWireBox().clearAppSingletons();

}

// Handler's Index Auto Reload

if ( cbController.getSetting( "HandlersIndexAutoReload" ) ) {

lock type="exclusive" name="#appHash#" timeout="#lockTimeout#" throwontimeout="true" {

cbController.getHandlerService().registerHandlers();

}

} catch ( Any e ) {

// process the exception

writeOutput( processException( cbController, e ) );

// abort it, something went really wrong.

abort;

}

return this;

}

/**

* Process a ColdBox Request

function processColdBoxRequest() output="true"{

// Get Controller Reference

var cbController = application[ locateAppKey() ];

// Local references

var interceptorService = cbController.getInterceptorService();

var cacheBox = cbController.getCacheBox();

try {

// set request time, for info purposes

request.fwExecTime = getTickCount();

// Load Module Mappings since dumb CFML engines can't keep state on this.

cbController.getModuleService().loadMappings();

// Create Request Context & Capture Request

var event = cbController.getRequestService().requestCapture();

// ****** PRE PROCESS *******/

interceptorService.announce( "preProcess" );

// Route-scoped middleware runs after the global preProcess chain, closest to the handler

cbController.getRoutingService().runRouteMiddleware( event, "preProcess" );

if ( len( cbController.getSetting( "RequestStartHandler" ) ) ) {

cbController.runEvent(

event : cbController.getSetting( "RequestStartHandler" ),

prePostExempt: true

);

}

// ****** EVENT CACHING CONTENT DELIVERY *******/

var refResults = {};

var eCacheEntry = event.getEventCacheableEntry();

// Verify if event caching item is in selected cache

if ( eCacheEntry.keyExists( "cachekey" ) ) {

// Get cache element.

refResults.eventCaching = cacheBox.getCache( eCacheEntry.provider ).get( eCacheEntry.cacheKey );

}

// Verify if cached content existed.

if ( !isNull( local.refresults.eventCaching ) ) {

// check renderdata

if ( local.refResults.eventCaching.renderData ) {

local.refResults.eventCaching.controller = cbController;

renderDataSetup( argumentCollection = local.refResults.eventCaching );

}

// Caching Header Identifier

getPageContextResponse().setHeader( "x-coldbox-cache-response", "true" );

// Response Headers that were cached

local.refResults.eventCaching.responseHeaders.each( function( key, value ){

event.setHTTPHeader( name = key, value = value );

} );

// ****** HTTP CACHING - TIER 1 conditional-GET (docs/specs/http-caching.md §4.2) ******

// Replay whatever conditional-GET headers were stored alongside this entry, reusing

// event.etag()/event.lastModified() for the actual header-set + match logic rather

// than re-implementing it here - same matching rules (weak comparison, If-None-Match

// lists/`*`, the If-Modified-Since-is-ignored-when-If-None-Match-is-present

// precedence) whether the tag was just computed or is being replayed from cache.

var cachedNotModified = false;

if ( structKeyExists( local.refResults.eventCaching, "etag" ) ) {

cachedNotModified = event.etag(

value = local.refResults.eventCaching.etag,

weak = local.refResults.eventCaching.etagWeak ?: false

);

}

if ( structKeyExists( local.refResults.eventCaching, "lastModified" ) ) {

cachedNotModified = event.lastModified( local.refResults.eventCaching.lastModified ) || cachedNotModified;

}

if ( structKeyExists( local.refResults.eventCaching, "cacheControl" ) ) {

event.setHTTPHeader(

name = "Cache-Control",

value = local.refResults.eventCaching.cacheControl

);

}

// Cached Status Code - a conditional-GET match already set 304 via etag()/lastModified() above.

if (

!cachedNotModified &&

isNumeric( local.refResults.eventCaching.statusCode ) && local.refResults.eventCaching.statusCode > 0

) {

event.setHTTPHeader( statusCode = local.refResults.eventCaching.statusCode );

}

// Render Content as binary or just output - skipped entirely on a conditional-GET

// match, which is the whole point: no body write at all, not even a replay.

if ( !cachedNotModified ) {

if ( local.refResults.eventCaching.isBinary ) {

cbController

.getDataMarshaller()

.renderContent(

type = "#local.refResults.eventCaching.contentType#",

variable = "#local.refResults.eventCaching.renderedContent#"

);

} else {

cbController

.getDataMarshaller()

.renderContent( type = "#local.refResults.eventCaching.contentType#", reset = true );

writeOutput( local.refResults.eventCaching.renderedContent );

}

} else {

// ****** EXECUTE MAIN EVENT *******/

if ( NOT event.getIsNoExecution() ) {

local.refResults.results = cbController.runEvent( defaultEvent = true );

}

// ****** RENDERING PROCEDURES *******/

if ( not event.isNoRender() ) {

var renderedContent = "";

// pre layout

interceptorService.announce( "preLayout" );

// Check for Marshalling and data render

var renderData = event.getRenderData();

// Rendering/Marshalling of content

if ( !structIsEmpty( renderData ) ) {

renderedContent = cbController

.getDataMarshaller()

.marshallData( argumentCollection = renderData );

}

// Check if handler returned results

else if ( !isNull( local.refResults.results ) ) {

// If simple, just return it back, evaluates to HTML

if ( isSimpleValue( local.refResults.results ) ) {

renderedContent = local.refResults.results;

}

// ColdBox does native JSON if you return a complex object.

else {

renderedContent = cbController.getUtil().toJson( local.refResults.results );

getPageContextResponse().setContentType( "application/json;charset=utf-8" );

}

// Render Layout/View pair via set variable to eliminate whitespace

else {

renderedContent = cbcontroller

.getRenderer()

.layout(

module = event.getCurrentLayoutModule(),

viewModule = event.getCurrentViewModule()

);

}

// ****** PRE-RENDER EVENTS *******/

var interceptorData = { renderedContent : renderedContent };

interceptorService.announce( "preRender", interceptorData );

// replace back content in case of modification, strings passed by value

renderedContent = interceptorData.renderedContent;

// ****** EVENT CACHING *******/

var eCacheEntry = event.getEventCacheableEntry();

if (

eCacheEntry.keyExists( "cacheKey" ) AND

getPageContextResponse().getStatus() neq 500 AND

(

renderData.isEmpty()

(

renderData.keyExists( "statusCode" ) and

renderdata.statusCode neq 500

)

) {

// prepare storage entry

var cacheEntry = {

renderedContent : renderedContent,

renderData : !renderData.isEmpty(),

contentType : !isNull( renderData.contentType ) ? renderData.contentType : getPageContextResponse().getContentType() ?: "text/html",

encoding : "UTF-8",

statusCode : getPageContextResponse().getStatus(),

isBinary : false,

responseHeaders : event.getResponseHeaders()

};

// ****** HTTP CACHING - TIER 1 (docs/specs/http-caching.md §4.2/§4.4) ******

// Opt-in via etag/lastModified/cacheControl annotations alongside cache=true.

// Computed once, right here at write time, and stored on the entry so every

// subsequent cache hit can compare against it for free - no per-request hashing.

if ( eCacheEntry.etag ) {

cacheEntry.etag = hash( renderedContent, "MD5" );

cacheEntry.etagWeak = eCacheEntry.etagWeak;

event.setHTTPHeader(

name = "ETag",

value = ( eCacheEntry.etagWeak ? "W/" : "" ) & """#cacheEntry.etag#"""

);

}

if ( eCacheEntry.lastModified ) {

cacheEntry.lastModified = now();

event.setHTTPHeader(

name = "Last-Modified",

value = event.toHTTPDate( cacheEntry.lastModified )

);

}

if ( len( eCacheEntry.cacheControl ) ) {

cacheEntry.cacheControl = eCacheEntry.cacheControl;

} else if (

( eCacheEntry.etag || eCacheEntry.lastModified ) &&

isNumeric( eCacheEntry.timeout )

) {

// No explicit directive, but the handler opted into conditional-GET

// support - default to telling the client the same lifetime the

// handler already told CacheBox (in minutes; Cache-Control wants

// seconds), rather than saying nothing at all. A blank cacheTimeout

// means "use the provider's default", which we can't translate to a

// max-age, so no default is inferred in that case.

cacheEntry.cacheControl = "private, max-age=#eCacheEntry.timeout * 60#";

}

if ( structKeyExists( cacheEntry, "cacheControl" ) ) {

event.setHTTPHeader( name = "Cache-Control", value = cacheEntry.cacheControl );

}

// is this a render data entry? If So, append data

if ( !renderData.isEmpty() ) {

structAppend( cacheEntry, renderData, true );

}

// Cache it

cacheBox

.getCache( eCacheEntry.provider )

.set(

eCacheEntry.cacheKey,

cacheEntry,

eCacheEntry.timeout,

eCacheEntry.lastAccessTimeout

);

}

// end event caching

// Render Data? With stupid CF whitespace stuff.

if ( !structIsEmpty( renderData ) ) {

renderData.controller = cbController;

renderDataSetup( argumentCollection = renderData );

// Binary

if ( renderData.isBinary ) {

cbController

.getDataMarshaller()

.renderContent( type = "#renderData.contentType#", variable = "#renderedContent#" );

}

// Non Binary

else {

writeOutput( renderedContent );

}

} else {

writeOutput( renderedContent );

}

// Post rendering event

interceptorService.announce( "postRender" );

}

// end no render

}

// end normal rendering procedures

// ****** POST PROCESS *******/

if ( len( cbController.getSetting( "RequestEndHandler" ) ) ) {

cbController.runEvent(

event = cbController.getSetting( "RequestEndHandler" ),

prePostExempt = true

);

}

// Route-scoped middleware runs before the global postProcess chain, closest to the handler

cbController.getRoutingService().runRouteMiddleware( event, "postProcess" );

interceptorService.announce( "postProcess" );

// ****** FLASH AUTO-SAVE *******/

// Streams are skipped: flash is a page transition concept, and a stream can be held

// open for minutes, so persisting here would attach values to an unrelated later request.

if ( cbController.getSetting( "flash" ).autoSave && !event.isSSE() ) {

cbController

.getRequestService()

.getFlashScope()

.saveFlash();

}

} catch ( Any e ) {

// process the exception and render its report

writeOutput( processException( cbController, e ) );

}

// Time the request

request.fwExecTime = getTickCount() - request.fwExecTime;

}

/**

* Verify if a reinit is sent

boolean function isFWReinit(){

var appKey = locateAppKey();

// CF Parm Structures just in case

param name="FORM" default="#structNew()#";

param name="URL" default="#structNew()#";

// Check if app exists already in scope

if ( not structKeyExists( application, appKey ) ) {

return true;

}

// Verify the reinit key is passed

var reinitKey = application[ appKey ].getSetting( "reinitKey", "fwreinit" );

if ( structKeyExists( url, reinitKey ) or structKeyExists( form, reinitKey ) ) {

// Check if we have a reinit password at hand.

var reinitPass = application[ appKey ].getSetting( name = "reinitPassword", defaultValue = "" );

// pass Checks

if ( NOT len( reinitPass ) ) {

return true;

}

// Get the incoming pass from form or url

var incomingPass = "";

if ( structKeyExists( form, reinitKey ) ) {

incomingPass = form[ reinitKey ];

} else {

incomingPass = url[ reinitKey ];

}

// Compare the passwords

if ( compare( reinitPass, hash( incomingPass ) ) eq 0 ) {

return true;

} else {

application[ appKey ].getLog().warn( "The incoming reinit password is not valid." );

}

// else if reinit found.

return false;

}

/************************************** APP.CFC FACADES *********************************************/

/**

* This fire on every request, it will process a ColdBox request if the target page is index.cfm or index.bxm

* Also note that this method will output content directly so do not try to return anything from it.

* @targetPage The target page of the request

boolean function onRequestStart( required targetPage ) output=true{

// Global flag to denote if we are in mid reinit or not.

cfparam( name = "application.fwReinit", default = false );

// Fail fast so users coming in during a reinit just get a please try again message.

if ( application.fwReinit ) {

// Closure or UDF

if ( isClosure( variables.COLDBOX_FAIL_FAST ) || isCustomFunction( variables.COLDBOX_FAIL_FAST ) ) {

variables.COLDBOX_FAIL_FAST();

return false;

}

// Core Fail Fast Option

else if ( isBoolean( variables.COLDBOX_FAIL_FAST ) && variables.COLDBOX_FAIL_FAST ) {

writeOutput( "Oops! Seems ColdBox is still not ready to serve requests, please try again." );

// You don't have to return a 500, I just did this so JMeter would report it differently than a 200

cfheader( statusCode = "503" );

// Break up!

return false;

}

// Verify Reloading

reloadChecks();

// Process A ColdBox Request Only

// If the file is "index.(cfm|bxm)" then we will process it

if ( reFindNoCase( "index\.(cfm|bxm)", listLast( arguments.targetPage, "/" ) ) ) {

processColdBoxRequest();

return false;

} else {

// Just load the module mappings in case we are in a module request or a web socket request.

application[ locateAppKey() ].getModuleService().loadMappings();

return true;

}

/**

* ON missing template

boolean function onMissingTemplate( required template ){

// get reference

var cbController = application[ locateAppKey() ]

// Execute Missing Template Handler if it exists

if ( len( cbController.getSetting( "MissingTemplateHandler" ) ) ) {

// Save missing template in RC and right handler for this call.

var event = cbController.getRequestService().getContext()

event

.setValue( "missingTemplate", arguments.template )

.setValue(

cbController.getSetting( "EventName" ),

cbController.getSetting( "MissingTemplateHandler" )

)

// Process it

if ( fileExists( cbController.locateFilePath( "index.bxm" ) ) ) {

onRequestStart( "index.bxm" )

} else {

onRequestStart( "index.cfm" )

}

// Return processed

return true

}

return false

}

/**

* ON session start

function onSessionStart(){

// Exit if we don't have the app key in scope, means we are not ready to process session start yet.

if ( !application.keyExists( locateAppKey() ) ) {

return;

}

var cbController = application[ locateAppKey() ]

// Session start interceptors

cbController.getInterceptorService().announce( "sessionStart", session )

// Execute Session Start Handler

var sessionHandler = cbController.getSetting( name: "SessionStartHandler", defaultValue = "" )

if ( len( sessionHandler ) ) {

cbController.runEvent( event = sessionHandler, prePostExempt = true )

}

/**

* ON session end

function onSessionEnd( required struct sessionScope, struct appScope ){

var cbController = ""

// Check for cb Controller

if ( structKeyExists( arguments.appScope, locateAppKey() ) ) {

cbController = arguments.appScope[ locateAppKey() ]

}

// Only process if ColdBox is initiated

if ( not isSimpleValue( cbController ) && cbController.getColdboxInitiated() ) {

// Get Context

var event = cbController.getRequestService().getContext()

// Execute interceptors

var iData = {

sessionReference : arguments.sessionScope,

applicationReference : arguments.appScope

}

cbController.getInterceptorService().announce( "sessionEnd", iData )

// Execute Session End Handler

if ( len( cbController.getSetting( "SessionEndHandler" ) ) ) {

// Place session reference on event object

event

.setValue( "sessionReference", arguments.sessionScope )

.setValue( "applicationReference", arguments.appScope )

// Execute the Handler

cbController.runEvent(

event = cbController.getSetting( "SessionEndHandler" ),

prepostExempt = true

)

}

/**

* When the application starts, ColdBox will be loaded into application scope

boolean function onApplicationStart(){

// Load ColdBox

loadColdBox()

return true

}

/**

* Tear down the application and execute shutdown procedures

function onApplicationEnd( struct appScope ){

var cbController = arguments.appScope[ locateAppKey() ]

// Execute Application End interceptors

cbController.getInterceptorService().announce( "applicationEnd" )

// Execute Application End Handler

if ( len( cbController.getSetting( "applicationEndHandler" ) ) ) {

cbController.runEvent(

event = cbController.getSetting( "applicationEndHandler" ),

prePostExempt = true

)

}

// Controlled service shutdown operations

cbController.getLoaderService().processShutdown()

}

/************************************** PRIVATE HELPERS *********************************************/

/**

* Process an exception and returns a rendered bug report

* @controller The ColdBox Controller

* @exception The ColdFusion exception

private string function processException( required controller, required exception ){

// prepare exception facade object + app logger

var oException = new coldbox.system.web.context.ExceptionBean( arguments.exception )

var appLogger = arguments.controller.getLogBox().getLogger( this )

var event = arguments.controller.getRequestService().getContext()

var rc = event.getCollection()

var prc = event.getPrivateCollection()

// Announce interception

arguments.controller.getInterceptorService().announce( "onException", { exception : arguments.exception } )

// Store exception in private context

event.setPrivateValue( "exception", oException )

// Set Exception Header

getPageContextResponse().setStatus( 500 )

// Run custom Exception handler if Found, else run default exception routines

if ( len( arguments.controller.getSetting( "ExceptionHandler" ) ) ) {

try {

arguments.controller.runEvent( arguments.controller.getSetting( "Exceptionhandler" ) )

} catch ( Any e ) {

// Log Original Error First

appLogger.error(

"Original Error: #arguments.exception.message# #arguments.exception.detail# ",

arguments.exception

)

// Log Exception Handler Error

appLogger.error(

"Error running exception handler: #arguments.controller.getSetting( "ExceptionHandler" )# #e.message# #e.detail#",

)

// rethrow error

rethrow;

}

} else {

// Log Error

appLogger.error(

"Error: #arguments.exception.message# #arguments.exception.detail# ",

arguments.exception

)

}

// Render out error via CustomErrorTemplate or Core

var customErrorTemplate = arguments.controller.getSetting( "CustomErrorTemplate" )

if ( len( customErrorTemplate ) ) {

// Get app location path

var appLocation = "/"

if ( len( arguments.controller.getSetting( "AppMapping" ) ) ) {

appLocation = appLocation & arguments.controller.getSetting( "AppMapping" ) & "/"

}

var bugReportRelativePath = appLocation & reReplace( customErrorTemplate, "^/", "" )

var bugReportAbsolutePath = customErrorTemplate

// Show Bug Report

savecontent variable="local.exceptionReport" {

// Do we have right path already, test by expanding

if ( fileExists( expandPath( bugReportRelativePath ) ) ) {

include "#bugReportRelativePath#";

} else {

include "#bugReportAbsolutePath#";

}

} else {

// Default ColdBox Error Template

savecontent variable="local.exceptionReport" {

include "/coldbox/system/exceptions/BugReport-Public.cfm";

}

return local.exceptionReport

}

/**

* Process render data setup

* @controller The ColdBox controller

* @statusCode The status code to send

* @contentType The content type to send

* @encoding The content encoding

private Bootstrap function renderDataSetup(

required controller,

required statusCode,

required contentType,

required encoding

){

// Status Codes

getPageContextResponse().setStatus( arguments.statusCode )

// Render the Data Content Type

controller

.getDataMarshaller()

.renderContent(

type : arguments.contentType,

encoding: arguments.encoding,

reset : true

)

return this

}

/**

* Locate the application key

private function locateAppKey(){

if ( len( trim( variables.COLDBOX_APP_KEY ) ) ) {

return variables.COLDBOX_APP_KEY

}

return "cbController"

}

/**

* Helper method to deal with ACF's overload of the page context response, come on Adobe, get your act together!

private function getPageContextResponse(){

if ( server.keyExists( "boxlang" ) || server.keyExists( "lucee" ) ) {

return getPageContext().getResponse()

}

return getPageContext().getResponse().getResponse()

}

coldbox-platform/system/Bootstrap.cfc at development · ColdBox/coldbox-platform · GitHub

Uh oh!

Expand file tree

Breadcrumbs

Bootstrap.cfc

Latest commit

History

Breadcrumbs

Bootstrap.cfc

File metadata and controls