rstudio/src/cpp/session/SessionConsoleProcessPersist.cpp at master · pearsonca/rstudio · GitHub

History

394 lines (339 loc) · 9.27 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

* SessionConsoleProcessPersist.cpp

* Unless you have received this program directly from RStudio pursuant

* to the terms of a commercial license agreement with RStudio, then

* this program is licensed to you under the terms of version 3 of the

* GNU Affero General Public License. This program is distributed WITHOUT

* ANY EXPRESS OR IMPLIED WARRANTY, INCLUDING THOSE OF NON-INFRINGEMENT,

* MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Please refer to the

* AGPL (http://www.gnu.org/licenses/agpl-3.0.txt) for more details.

#include <session/SessionConsoleProcessPersist.hpp>

#include <gsl/gsl>

#include <core/FileSerializer.hpp>

#include <session/SessionModuleContext.hpp>

#include <session/SessionOptions.hpp>

#include <session/projects/SessionProjects.hpp>

using namespace rstudio::core;

namespace rstudio {

namespace session {

namespace console_process {

namespace console_persist {

#define kConsoleIndex "INDEX001"

// Change this constant if incompatible/version specific changes need to be

// made to ConsoleProcess/terminal persistence, e.g. "console02". Ideally

// this will be rare to never once we ship.

// 2017/02/03 - console -> console01

// Reset state to eliminate previously saved buffers that

// haven't had their alt-buffer stripped during save.

// 2017/03/08 - console01 -> console02

// Added shell type property to allow Windows to track

// multiple terminal types (cmd, powershell, git bash, etc.)

// 2017/03/21 - console02 -> console03

// Added channel type and channel ID to allow distinction of

// using non-RPC-based communication channel back to client

// 2017/05/15 - console03 -> console04

// Added current-working directory, alt-buffer, cols, rows

// 2017/06/8 - console04 -> console05

// Added autoClose, zombie

// 2017/06/16 - console05 -> console06

// Added trackEnv

// 2019/07/30 - console06 -> console07

// Changed shell type from int to string to align with user

// preferences

#define kConsoleDir "console07"

namespace {

FilePath s_consoleProcPath;

FilePath s_consoleProcIndexPath;

bool s_inited = false;

const std::string s_envFileExt = ".env";

void initialize()

{

if (s_inited) return;

if (session::options().multiSession() &&

session::options().programMode() == kSessionProgramModeServer)

{

// In multi-session mode, persist per session

s_consoleProcPath = module_context::sessionScratchPath().completePath(kConsoleDir);

}

else

{

// In single-session mode, persist in external project storage (not internally in the project

// since contents include environment values and can be sensitive)

s_consoleProcPath = projects::projectContext().externalStoragePath().completePath(kConsoleDir);

}

Error error = s_consoleProcPath.ensureDirectory();

if (error)

{

LOG_ERROR(error);

return;

}

s_consoleProcIndexPath = s_consoleProcPath.completePath(kConsoleIndex);

s_inited = true;

}

const FilePath& getConsoleProcPath()

{

initialize();

return s_consoleProcPath;

}

const FilePath& getConsoleProcIndexPath()

{

initialize();

return s_consoleProcIndexPath;

}

Error getLogFilePath(const std::string& handle, FilePath* pFile)

{

initialize();

Error error = getConsoleProcPath().ensureDirectory();

if (error)

{

return error;

}

*pFile = getConsoleProcPath().completePath(handle);

return Success();

}

Error getEnvFilePath(const std::string& handle, FilePath* pFile)

{

initialize();

Error error = getConsoleProcPath().ensureDirectory();

if (error)

{

return error;

}

std::string envHandle = handle;

envHandle.append(s_envFileExt);

*pFile = getConsoleProcPath().completePath(envHandle);

return Success();

}

} // anonymous namespace

std::string loadConsoleProcessMetadata()

{

std::string contents;

if (!getConsoleProcIndexPath().exists())

return "";

Error error = rstudio::core::readStringFromFile(getConsoleProcIndexPath(), &contents);

if (error)

{

LOG_ERROR(error);

return "";

}

return contents;

}

void saveConsoleProcesses(const std::string& metadata)

{

initialize();

if (!s_consoleProcPath.exists())

return;

Error error = rstudio::core::writeStringToFile(getConsoleProcIndexPath(),

metadata);

if (error)

LOG_ERROR(error);

}

std::string getSavedBuffer(const std::string& handle, int maxLines)

{

std::string content;

FilePath log;

Error error = getLogFilePath(handle, &log);

if (error)

{

LOG_ERROR(error);

return content;

}

if (!log.exists())

{

return "";

}

error = core::readStringFromFile(log, &content);

if (error)

{

LOG_ERROR(error);

return content;

}

if (maxLines < 1)

return content;

// Trim the buffer based on maxLines. Otherwise it can grow without

// bound until the terminal is closed or cleared.

std::string trimmedOutput = content;

if (string_utils::trimLeadingLines(maxLines, &trimmedOutput))

{

error = core::writeStringToFile(log, trimmedOutput);

if (error)

{

LOG_ERROR(error);

return content;

}

return trimmedOutput;

}

int getSavedBufferLineCount(const std::string& handle, int maxLines)

{

std::string buffer = getSavedBuffer(handle, maxLines);

return gsl::narrow_cast<int>(string_utils::countNewlines(buffer) + 1);

}

void appendToOutputBuffer(const std::string& handle, const std::string& buffer)

{

FilePath log;

Error error = getLogFilePath(handle, &log);

if (error)

{

LOG_ERROR(error);

return;

}

error = rstudio::core::appendToFile(log, buffer);

if (error)

{

LOG_ERROR(error);

}

void deleteLogFile(const std::string &handle, bool lastLineOnly)

{

FilePath log;

Error error = getLogFilePath(handle, &log);

if (error)

{

LOG_ERROR(error);

return;

}

if (!log.exists())

return;

if (!lastLineOnly)

{

// blow away the file

error = log.removeIfExists();

if (error)

{

LOG_ERROR(error);

return;

}

else

{

// read the file, remove last line and rewrite buffer

std::string content;

error = core::readStringFromFile(log, &content);

if (error)

{

LOG_ERROR(error);

return;

}

size_t lastNewline = content.find_last_of('\n');

// no complete line in buffer, just blow it away

if (lastNewline == std::string::npos)

{

deleteLogFile(handle, false);

return;

}

// erase everything after the final newline

content.erase(++lastNewline);

error = core::writeStringToFile(log, content);

if (error)

{

LOG_ERROR(error);

}

void deleteOrphanedLogs(bool (*validHandle)(const std::string&))

{

if (!validHandle)

return;

// Delete orphaned buffer files

std::vector<FilePath> children;

Error error = getConsoleProcPath().getChildren(children);

if (error)

{

LOG_ERROR(error);

return;

}

for (const FilePath& child : children)

{

// Don't erase the INDEXnnn or any subfolders

if (!child.getFilename().compare(kConsoleIndex) || child.isDirectory())

{

continue;

}

if (!validHandle(child.getStem()))

{

error = child.remove();

if (error)

LOG_ERROR(error);

}

void saveConsoleEnvironment(const std::string& handle, const core::system::Options& environment)

{

FilePath log;

Error error = getEnvFilePath(handle, &log);

if (error)

{

LOG_ERROR(error);

return;

}

json::Object envJson = json::Object(environment);

std::ostringstream ostr;

envJson.writeFormatted(ostr);

error = rstudio::core::writeStringToFile(log, ostr.str());

if (error)

{

LOG_ERROR(error);

}

void loadConsoleEnvironment(const std::string& handle, core::system::Options* pEnv)

{

FilePath log;

Error error = getEnvFilePath(handle, &log);

if (error)

{

LOG_ERROR(error);

return;

}

if (!log.exists())

return;

std::string jsonStr;

error = rstudio::core::readStringFromFile(log, &jsonStr);

if (error)

{

LOG_ERROR(error);

return;

}

json::Value envJson;

if (envJson.parse(jsonStr) ||

!json::isType<json::Object>(envJson))

{

LOG_ERROR(systemError(boost::system::errc::protocol_error,

"Error parsing terminal environment save file",

ERROR_LOCATION));

return;

}

core::system::Options loadedEnvironment = envJson.getObject().toStringPairList();

for (const core::system::Option& var : loadedEnvironment)

{

core::system::setenv(pEnv, var.first, var.second);

}

void deleteEnvFile(const std::string& handle)

{

FilePath log;

Error error = getEnvFilePath(handle, &log);

if (error)

{

LOG_ERROR(error);

return;

}

if (!log.exists())

return;

error = log.removeIfExists();

if (error)

{

LOG_ERROR(error);

return;

}

} // namespace console_persist

} // namespace console_process

} // namespace session

} // namespace rstudio

rstudio/src/cpp/session/SessionConsoleProcessPersist.cpp at master · pearsonca/rstudio · GitHub

Expand file tree

Breadcrumbs

SessionConsoleProcessPersist.cpp

Latest commit

History

Breadcrumbs

SessionConsoleProcessPersist.cpp

File metadata and controls