git.github.io/gitweb/gitweb.perl at next · USDOS/git.github.io · GitHub

History

executable file

8490 lines (7455 loc) · 248 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

#!/usr/bin/perl

# gitweb - simple web interface to track changes in git repositories

# This program is licensed under the GPLv2

use 5.008001;

use strict;

use warnings;

# handle ACL in file access tests

use filetest 'access';

use CGI qw(:standard :escapeHTML -nosticky);

use CGI::Util qw(unescape);

use CGI::Carp qw(fatalsToBrowser set_message);

use Encode;

use Fcntl ':mode';

use File::Find qw();

use File::Basename qw(basename);

use Time::HiRes qw(gettimeofday tv_interval);

use Digest::MD5 qw(md5_hex);

binmode STDOUT, ':utf8';

if (!defined($CGI::VERSION) || $CGI::VERSION < 4.08) {

eval 'sub CGI::multi_param { CGI::param(@_) }'

}

our $t0 = [ gettimeofday() ];

our $number_of_git_cmds = 0;

BEGIN {

CGI->compile() if $ENV{'MOD_PERL'};

}

our $version = "++GIT_VERSION++";

our ($my_url, $my_uri, $base_url, $path_info, $home_link);

sub evaluate_uri {

our $cgi;

our $my_url = $cgi->url();

our $my_uri = $cgi->url(-absolute => 1);

# Base URL for relative URLs in gitweb ($logo, $favicon, ...),

# needed and used only for URLs with nonempty PATH_INFO

our $base_url = $my_url;

# When the script is used as DirectoryIndex, the URL does not contain the name

# of the script file itself, and $cgi->url() fails to strip PATH_INFO, so we

# have to do it ourselves. We make $path_info global because it's also used

# later on.

# Another issue with the script being the DirectoryIndex is that the resulting

# $my_url data is not the full script URL: this is good, because we want

# generated links to keep implying the script name if it wasn't explicitly

# indicated in the URL we're handling, but it means that $my_url cannot be used

# as base URL.

# Therefore, if we needed to strip PATH_INFO, then we know that we have

# to build the base URL ourselves:

our $path_info = decode_utf8($ENV{"PATH_INFO"});

if ($path_info) {

# $path_info has already been URL-decoded by the web server, but

# $my_url and $my_uri have not. URL-decode them so we can properly

# strip $path_info.

$my_url = unescape($my_url);

$my_uri = unescape($my_uri);

if ($my_url =~ s,\Q$path_info\E$,, &&

$my_uri =~ s,\Q$path_info\E$,, &&

defined $ENV{'SCRIPT_NAME'}) {

$base_url = $cgi->url(-base => 1) . $ENV{'SCRIPT_NAME'};

}

# target of the home link on top of all pages

our $home_link = $my_uri || "/";

}

# core git executable to use

# this can just be "git" if your webserver has a sensible PATH

our $GIT = "++GIT_BINDIR++/git";

# absolute fs-path which will be prepended to the project path

#our $projectroot = "/pub/scm";

our $projectroot = "++GITWEB_PROJECTROOT++";

# fs traversing limit for getting project list

# the number is relative to the projectroot

our $project_maxdepth = "++GITWEB_PROJECT_MAXDEPTH++";

# string of the home link on top of all pages

our $home_link_str = "++GITWEB_HOME_LINK_STR++";

# extra breadcrumbs preceding the home link

our @extra_breadcrumbs = ();

# name of your site or organization to appear in page titles

# replace this with something more descriptive for clearer bookmarks

our $site_name = "++GITWEB_SITENAME++"

|| ($ENV{'SERVER_NAME'} || "Untitled") . " Git";

# html snippet to include in the <head> section of each page

our $site_html_head_string = "++GITWEB_SITE_HTML_HEAD_STRING++";

# filename of html text to include at top of each page

our $site_header = "++GITWEB_SITE_HEADER++";

# html text to include at home page

our $home_text = "++GITWEB_HOMETEXT++";

# filename of html text to include at bottom of each page

our $site_footer = "++GITWEB_SITE_FOOTER++";

# URI of stylesheets

our @stylesheets = ("++GITWEB_CSS++");

# URI of a single stylesheet, which can be overridden in GITWEB_CONFIG.

our $stylesheet = undef;

# URI of GIT logo (72x27 size)

our $logo = "++GITWEB_LOGO++";

# URI of GIT favicon, assumed to be image/png type

our $favicon = "++GITWEB_FAVICON++";

# URI of gitweb.js (JavaScript code for gitweb)

our $javascript = "++GITWEB_JS++";

# URI and label (title) of GIT logo link

#our $logo_url = "https://www.kernel.org/pub/software/scm/git/docs/";

#our $logo_label = "git documentation";

our $logo_url = "https://git-scm.com/";

our $logo_label = "git homepage";

# source of projects list

our $projects_list = "++GITWEB_LIST++";

# the width (in characters) of the projects list "Description" column

our $projects_list_description_width = 25;

# group projects by category on the projects list

# (enabled if this variable evaluates to true)

our $projects_list_group_categories = 0;

# default category if none specified

# (leave the empty string for no category)

our $project_list_default_category = "";

# default order of projects list

# valid values are none, project, descr, owner, and age

our $default_projects_order = "project";

# show repository only if this file exists

# (only effective if this variable evaluates to true)

our $export_ok = "++GITWEB_EXPORT_OK++";

# don't generate age column on the projects list page

our $omit_age_column = 0;

# don't generate information about owners of repositories

our $omit_owner=0;

# show repository only if this subroutine returns true

# when given the path to the project, for example:

# sub { return -e "$_[0]/git-daemon-export-ok"; }

our $export_auth_hook = undef;

# only allow viewing of repositories also shown on the overview page

our $strict_export = "++GITWEB_STRICT_EXPORT++";

# list of git base URLs used for URL to where fetch project from,

# i.e. full URL is "$git_base_url/$project"

our @git_base_url_list = grep { $_ ne '' } ("++GITWEB_BASE_URL++");

# default blob_plain mimetype and default charset for text/plain blob

our $default_blob_plain_mimetype = 'text/plain';

our $default_text_plain_charset = undef;

# file to use for guessing MIME types before trying /etc/mime.types

# (relative to the current git repository)

our $mimetypes_file = undef;

# assume this charset if line contains non-UTF-8 characters;

# it should be valid encoding (see Encoding::Supported(3pm) for list),

# for which encoding all byte sequences are valid, for example

# 'iso-8859-1' aka 'latin1' (it is decoded without checking, so it

# could be even 'utf-8' for the old behavior)

our $fallback_encoding = 'latin1';

# rename detection options for git-diff and git-diff-tree

# - default is '-M', with the cost proportional to

# (number of removed files) * (number of new files).

# - more costly is '-C' (which implies '-M'), with the cost proportional to

# (number of changed files + number of removed files) * (number of new files)

# - even more costly is '-C', '--find-copies-harder' with cost

# (number of files in the original tree) * (number of new files)

# - one might want to include '-B' option, e.g. '-B', '-M'

our @diff_opts = ('-M'); # taken from git_commit

# Disables features that would allow repository owners to inject script into

# the gitweb domain.

our $prevent_xss = 0;

# Path to the highlight executable to use (must be the one from

# http://andre-simon.de/zip/download.php due to assumptions about parameters and output).

# Useful if highlight is not installed on your webserver's PATH.

# [Default: highlight]

our $highlight_bin = "++HIGHLIGHT_BIN++";

# information about snapshot formats that gitweb is capable of serving

our %known_snapshot_formats = (

# name => {

# 'display' => display name,

# 'type' => mime type,

# 'suffix' => filename suffix,

# 'format' => --format for git-archive,

# 'compressor' => [compressor command and arguments]

# (array reference, optional)

# 'disabled' => boolean (optional)}

'tgz' => {

'display' => 'tar.gz',

'type' => 'application/x-gzip',

'suffix' => '.tar.gz',

'format' => 'tar',

'compressor' => ['gzip', '-n']},

'tbz2' => {

'display' => 'tar.bz2',

'type' => 'application/x-bzip2',

'suffix' => '.tar.bz2',

'format' => 'tar',

'compressor' => ['bzip2']},

'txz' => {

'display' => 'tar.xz',

'type' => 'application/x-xz',

'suffix' => '.tar.xz',

'format' => 'tar',

'compressor' => ['xz'],

'disabled' => 1},

'zip' => {

'display' => 'zip',

'type' => 'application/x-zip',

'suffix' => '.zip',

'format' => 'zip'},

);

# Aliases so we understand old gitweb.snapshot values in repository

# configuration.

our %known_snapshot_format_aliases = (

'gzip' => 'tgz',

'bzip2' => 'tbz2',

'xz' => 'txz',

# backward compatibility: legacy gitweb config support

'x-gzip' => undef, 'gz' => undef,

'x-bzip2' => undef, 'bz2' => undef,

'x-zip' => undef, '' => undef,

);

# Pixel sizes for icons and avatars. If the default font sizes or lineheights

# are changed, it may be appropriate to change these values too via

# $GITWEB_CONFIG.

our %avatar_size = (

'default' => 16,

'double' => 32

);

# Used to set the maximum load that we will still respond to gitweb queries.

# If server load exceed this value then return "503 server busy" error.

# If gitweb cannot determined server load, it is taken to be 0.

# Leave it undefined (or set to 'undef') to turn off load checking.

our $maxload = 300;

# configuration for 'highlight' (http://andre-simon.de/doku/highlight/en/highlight.php)

# match by basename

our %highlight_basename = (

#'Program' => 'py',

#'Library' => 'py',

'SConstruct' => 'py', # SCons equivalent of Makefile

'Makefile' => 'make',

);

# match by extension

our %highlight_ext = (

# main extensions, defining name of syntax;

# see files in /usr/share/highlight/langDefs/ directory

(map { $_ => $_ } qw(py rb java css js tex bib xml awk bat ini spec tcl sql)),

# alternate extensions, see /etc/highlight/filetypes.conf

(map { $_ => 'c' } qw(c h)),

(map { $_ => 'sh' } qw(sh bash zsh ksh)),

(map { $_ => 'cpp' } qw(cpp cxx c++ cc)),

(map { $_ => 'php' } qw(php php3 php4 php5 phps)),

(map { $_ => 'pl' } qw(pl perl pm)), # perhaps also 'cgi'

(map { $_ => 'make'} qw(make mak mk)),

(map { $_ => 'xml' } qw(xml xhtml html htm)),

);

# You define site-wide feature defaults here; override them with

# $GITWEB_CONFIG as necessary.

our %feature = (

# feature => {

# 'sub' => feature-sub (subroutine),

# 'override' => allow-override (boolean),

# 'default' => [ default options...] (array reference)}

# if feature is overridable (it means that allow-override has true value),

# then feature-sub will be called with default options as parameters;

# return value of feature-sub indicates if to enable specified feature

# if there is no 'sub' key (no feature-sub), then feature cannot be

# overridden

# use gitweb_get_feature(<feature>) to retrieve the <feature> value

# (an array) or gitweb_check_feature(<feature>) to check if <feature>

# is enabled

# Enable the 'blame' blob view, showing the last commit that modified

# each line in the file. This can be very CPU-intensive.

# To enable system wide have in $GITWEB_CONFIG

# $feature{'blame'}{'default'} = [1];

# To have project specific config enable override in $GITWEB_CONFIG

# $feature{'blame'}{'override'} = 1;

# and in project config gitweb.blame = 0|1;

'blame' => {

'sub' => sub { feature_bool('blame', @_) },

'override' => 0,

'default' => [0]},

# Enable the 'snapshot' link, providing a compressed archive of any

# tree. This can potentially generate high traffic if you have large

# project.

# Value is a list of formats defined in %known_snapshot_formats that

# you wish to offer.

# To disable system wide have in $GITWEB_CONFIG

# $feature{'snapshot'}{'default'} = [];

# To have project specific config enable override in $GITWEB_CONFIG

# $feature{'snapshot'}{'override'} = 1;

# and in project config, a comma-separated list of formats or "none"

# to disable. Example: gitweb.snapshot = tbz2,zip;

'snapshot' => {

'sub' => \&feature_snapshot,

'override' => 0,

'default' => ['tgz']},

# Enable text search, which will list the commits which match author,

# committer or commit text to a given string. Enabled by default.

# Project specific override is not supported.

# Note that this controls all search features, which means that if

# it is disabled, then 'grep' and 'pickaxe' search would also be

# disabled.

'search' => {

'override' => 0,

'default' => [1]},

# Enable grep search, which will list the files in currently selected

# tree containing the given string. Enabled by default. This can be

# potentially CPU-intensive, of course.

# Note that you need to have 'search' feature enabled too.

# To enable system wide have in $GITWEB_CONFIG

# $feature{'grep'}{'default'} = [1];

# To have project specific config enable override in $GITWEB_CONFIG

# $feature{'grep'}{'override'} = 1;

# and in project config gitweb.grep = 0|1;

'grep' => {

'sub' => sub { feature_bool('grep', @_) },

'override' => 0,

'default' => [1]},

# Enable the pickaxe search, which will list the commits that modified

# a given string in a file. This can be practical and quite faster

# alternative to 'blame', but still potentially CPU-intensive.

# Note that you need to have 'search' feature enabled too.

# To enable system wide have in $GITWEB_CONFIG

# $feature{'pickaxe'}{'default'} = [1];

# To have project specific config enable override in $GITWEB_CONFIG

# $feature{'pickaxe'}{'override'} = 1;

# and in project config gitweb.pickaxe = 0|1;

'pickaxe' => {

'sub' => sub { feature_bool('pickaxe', @_) },

'override' => 0,

'default' => [1]},

# Enable showing size of blobs in a 'tree' view, in a separate

# column, similar to what 'ls -l' does. This cost a bit of IO.

# To disable system wide have in $GITWEB_CONFIG

# $feature{'show-sizes'}{'default'} = [0];

# To have project specific config enable override in $GITWEB_CONFIG

# $feature{'show-sizes'}{'override'} = 1;

# and in project config gitweb.showsizes = 0|1;

'show-sizes' => {

'sub' => sub { feature_bool('showsizes', @_) },

'override' => 0,

'default' => [1]},

# Make gitweb use an alternative format of the URLs which can be

# more readable and natural-looking: project name is embedded

# directly in the path and the query string contains other

# auxiliary information. All gitweb installations recognize

# URL in either format; this configures in which formats gitweb

# generates links.

# To enable system wide have in $GITWEB_CONFIG

# $feature{'pathinfo'}{'default'} = [1];

# Project specific override is not supported.

# Note that you will need to change the default location of CSS,

# favicon, logo and possibly other files to an absolute URL. Also,

# if gitweb.cgi serves as your indexfile, you will need to force

# $my_uri to contain the script name in your $GITWEB_CONFIG.

'pathinfo' => {

'override' => 0,

'default' => [0]},

# Make gitweb consider projects in project root subdirectories

# to be forks of existing projects. Given project $projname.git,

# projects matching $projname/*.git will not be shown in the main

# projects list, instead a '+' mark will be added to $projname

# there and a 'forks' view will be enabled for the project, listing

# all the forks. If project list is taken from a file, forks have

# to be listed after the main project.

# To enable system wide have in $GITWEB_CONFIG

# $feature{'forks'}{'default'} = [1];

# Project specific override is not supported.

'forks' => {

'override' => 0,

'default' => [0]},

# Insert custom links to the action bar of all project pages.

# This enables you mainly to link to third-party scripts integrating

# into gitweb; e.g. git-browser for graphical history representation

# or custom web-based repository administration interface.

# The 'default' value consists of a list of triplets in the form

# (label, link, position) where position is the label after which

# to insert the link and link is a format string where %n expands

# to the project name, %f to the project path within the filesystem,

# %h to the current hash (h gitweb parameter) and %b to the current

# hash base (hb gitweb parameter); %% expands to %.

# To enable system wide have in $GITWEB_CONFIG e.g.

# $feature{'actions'}{'default'} = [('graphiclog',

# '/git-browser/by-commit.html?r=%n', 'summary')];

# Project specific override is not supported.

'actions' => {

'override' => 0,

'default' => []},

# Allow gitweb scan project content tags of project repository,

# and display the popular Web 2.0-ish "tag cloud" near the projects

# list. Note that this is something COMPLETELY different from the

# normal Git tags.

# gitweb by itself can show existing tags, but it does not handle

# tagging itself; you need to do it externally, outside gitweb.

# The format is described in git_get_project_ctags() subroutine.

# You may want to install the HTML::TagCloud Perl module to get

# a pretty tag cloud instead of just a list of tags.

# To enable system wide have in $GITWEB_CONFIG

# $feature{'ctags'}{'default'} = [1];

# Project specific override is not supported.

# In the future whether ctags editing is enabled might depend

# on the value, but using 1 should always mean no editing of ctags.

'ctags' => {

'override' => 0,

'default' => [0]},

# The maximum number of patches in a patchset generated in patch

# view. Set this to 0 or undef to disable patch view, or to a

# negative number to remove any limit.

# To disable system wide have in $GITWEB_CONFIG

# $feature{'patches'}{'default'} = [0];

# To have project specific config enable override in $GITWEB_CONFIG

# $feature{'patches'}{'override'} = 1;

# and in project config gitweb.patches = 0|n;

# where n is the maximum number of patches allowed in a patchset.

'patches' => {

'sub' => \&feature_patches,

'override' => 0,

'default' => [16]},

# Avatar support. When this feature is enabled, views such as

# shortlog or commit will display an avatar associated with

# the email of the committer(s) and/or author(s).

# Currently available providers are gravatar and picon.

# If an unknown provider is specified, the feature is disabled.

# Picon currently relies on the indiana.edu database.

# To enable system wide have in $GITWEB_CONFIG

# $feature{'avatar'}{'default'} = ['<provider>'];

# where <provider> is either gravatar or picon.

# To have project specific config enable override in $GITWEB_CONFIG

# $feature{'avatar'}{'override'} = 1;

# and in project config gitweb.avatar = <provider>;

'avatar' => {

'sub' => \&feature_avatar,

'override' => 0,

'default' => ['']},

# Enable displaying how much time and how many git commands

# it took to generate and display page. Disabled by default.

# Project specific override is not supported.

'timed' => {

'override' => 0,

'default' => [0]},

# Enable turning some links into links to actions which require

# JavaScript to run (like 'blame_incremental'). Not enabled by

# default. Project specific override is currently not supported.

'javascript-actions' => {

'override' => 0,

'default' => [0]},

# Enable and configure ability to change common timezone for dates

# in gitweb output via JavaScript. Enabled by default.

# Project specific override is not supported.

'javascript-timezone' => {

'override' => 0,

'default' => [

'local', # default timezone: 'utc', 'local', or '(-|+)HHMM' format,

# or undef to turn off this feature

'gitweb_tz', # name of cookie where to store selected timezone

'datetime', # CSS class used to mark up dates for manipulation

]},

# Syntax highlighting support. This is based on Daniel Svensson's

# and Sham Chukoury's work in gitweb-xmms2.git.

# It requires the 'highlight' program present in $PATH,

# and therefore is disabled by default.

# To enable system wide have in $GITWEB_CONFIG

# $feature{'highlight'}{'default'} = [1];

'highlight' => {

'sub' => sub { feature_bool('highlight', @_) },

'override' => 0,

'default' => [0]},

# Enable displaying of remote heads in the heads list

# To enable system wide have in $GITWEB_CONFIG

# $feature{'remote_heads'}{'default'} = [1];

# To have project specific config enable override in $GITWEB_CONFIG

# $feature{'remote_heads'}{'override'} = 1;

# and in project config gitweb.remoteheads = 0|1;

'remote_heads' => {

'sub' => sub { feature_bool('remote_heads', @_) },

'override' => 0,

'default' => [0]},

# Enable showing branches under other refs in addition to heads

# To set system wide extra branch refs have in $GITWEB_CONFIG

# $feature{'extra-branch-refs'}{'default'} = ['dirs', 'of', 'choice'];

# To have project specific config enable override in $GITWEB_CONFIG

# $feature{'extra-branch-refs'}{'override'} = 1;

# and in project config gitweb.extrabranchrefs = dirs of choice

# Every directory is separated with whitespace.

'extra-branch-refs' => {

'sub' => \&feature_extra_branch_refs,

'override' => 0,

'default' => []},

# Redact e-mail addresses.

# To enable system wide have in $GITWEB_CONFIG

# $feature{'email-privacy'}{'default'} = [1];

'email-privacy' => {

'sub' => sub { feature_bool('email-privacy', @_) },

'override' => 1,

'default' => [0]},

);

sub gitweb_get_feature {

my ($name) = @_;

return unless exists $feature{$name};

my ($sub, $override, @defaults) = (

$feature{$name}{'sub'},

$feature{$name}{'override'},

@{$feature{$name}{'default'}});

# project specific override is possible only if we have project

our $git_dir; # global variable, declared later

if (!$override || !defined $git_dir) {

return @defaults;

}

if (!defined $sub) {

warn "feature $name is not overridable";

return @defaults;

}

return $sub->(@defaults);

}

# A wrapper to check if a given feature is enabled.

# With this, you can say

# my $bool_feat = gitweb_check_feature('bool_feat');

# gitweb_check_feature('bool_feat') or somecode;

# instead of

# my ($bool_feat) = gitweb_get_feature('bool_feat');

# (gitweb_get_feature('bool_feat'))[0] or somecode;

sub gitweb_check_feature {

return (gitweb_get_feature(@_))[0];

}

sub feature_bool {

my $key = shift;

my ($val) = git_get_project_config($key, '--bool');

if (!defined $val) {

return ($_[0]);

} elsif ($val eq 'true') {

return (1);

} elsif ($val eq 'false') {

return (0);

}

sub feature_snapshot {

my (@fmts) = @_;

my ($val) = git_get_project_config('snapshot');

if ($val) {

@fmts = ($val eq 'none' ? () : split /\s*[,\s]\s*/, $val);

}

return @fmts;

}

sub feature_patches {

my @val = (git_get_project_config('patches', '--int'));

if (@val) {

return @val;

}

return ($_[0]);

}

sub feature_avatar {

my @val = (git_get_project_config('avatar'));

return @val ? @val : @_;

}

sub feature_extra_branch_refs {

my (@branch_refs) = @_;

my $values = git_get_project_config('extrabranchrefs');

if ($values) {

$values = config_to_multi ($values);

@branch_refs = ();

foreach my $value (@{$values}) {

push @branch_refs, split /\s+/, $value;

}

return @branch_refs;

}

# checking HEAD file with -e is fragile if the repository was

# initialized long time ago (i.e. symlink HEAD) and was pack-ref'ed

# and then pruned.

sub check_head_link {

my ($dir) = @_;

my $headfile = "$dir/HEAD";

return ((-e $headfile) ||

(-l $headfile && readlink($headfile) =~ /^refs\/heads\//));

}

sub check_export_ok {

my ($dir) = @_;

return (check_head_link($dir) &&

(!$export_ok || -e "$dir/$export_ok") &&

(!$export_auth_hook || $export_auth_hook->($dir)));

}

# process alternate names for backward compatibility

# filter out unsupported (unknown) snapshot formats

sub filter_snapshot_fmts {

my @fmts = @_;

@fmts = map {

exists $known_snapshot_format_aliases{$_} ?

$known_snapshot_format_aliases{$_} : $_} @fmts;

@fmts = grep {

exists $known_snapshot_formats{$_} &&

!$known_snapshot_formats{$_}{'disabled'}} @fmts;

}

sub filter_and_validate_refs {

my @refs = @_;

my %unique_refs = ();

foreach my $ref (@refs) {

die_error(500, "Invalid ref '$ref' in 'extra-branch-refs' feature") unless (is_valid_ref_format($ref));

# 'heads' are added implicitly in get_branch_refs().

$unique_refs{$ref} = 1 if ($ref ne 'heads');

}

return sort keys %unique_refs;

}

# If it is set to code reference, it is code that it is to be run once per

# request, allowing updating configurations that change with each request,

# while running other code in config file only once.

# Otherwise, if it is false then gitweb would process config file only once;

# if it is true then gitweb config would be run for each request.

our $per_request_config = 1;

# read and parse gitweb config file given by its parameter.

# returns true on success, false on recoverable error, allowing

# to chain this subroutine, using first file that exists.

# dies on errors during parsing config file, as it is unrecoverable.

sub read_config_file {

my $filename = shift;

return unless defined $filename;

if (-e $filename) {

do $filename;

# die if there is a problem accessing the file

die $! if $!;

# die if there are errors parsing config file

die $@ if $@;

return 1;

}

return;

}

our ($GITWEB_CONFIG, $GITWEB_CONFIG_SYSTEM, $GITWEB_CONFIG_COMMON);

sub evaluate_gitweb_config {

our $GITWEB_CONFIG = $ENV{'GITWEB_CONFIG'} || "++GITWEB_CONFIG++";

our $GITWEB_CONFIG_SYSTEM = $ENV{'GITWEB_CONFIG_SYSTEM'} || "++GITWEB_CONFIG_SYSTEM++";

our $GITWEB_CONFIG_COMMON = $ENV{'GITWEB_CONFIG_COMMON'} || "++GITWEB_CONFIG_COMMON++";

# Protect against duplications of file names, to not read config twice.

# Only one of $GITWEB_CONFIG and $GITWEB_CONFIG_SYSTEM is used, so

# there possibility of duplication of filename there doesn't matter.

$GITWEB_CONFIG = "" if ($GITWEB_CONFIG eq $GITWEB_CONFIG_COMMON);

$GITWEB_CONFIG_SYSTEM = "" if ($GITWEB_CONFIG_SYSTEM eq $GITWEB_CONFIG_COMMON);

# Common system-wide settings for convenience.

# Those settings can be overridden by GITWEB_CONFIG or GITWEB_CONFIG_SYSTEM.

read_config_file($GITWEB_CONFIG_COMMON);

# Use first config file that exists. This means use the per-instance

# GITWEB_CONFIG if exists, otherwise use GITWEB_SYSTEM_CONFIG.

read_config_file($GITWEB_CONFIG) and return;

read_config_file($GITWEB_CONFIG_SYSTEM);

}

# Get loadavg of system, to compare against $maxload.

# Currently it requires '/proc/loadavg' present to get loadavg;

# if it is not present it returns 0, which means no load checking.

sub get_loadavg {

if( -e '/proc/loadavg' ){

open my $fd, '<', '/proc/loadavg'

or return 0;

my @load = split(/\s+/, scalar <$fd>);

close $fd;

# The first three columns measure CPU and IO utilization of the last one,

# five, and 10 minute periods. The fourth column shows the number of

# currently running processes and the total number of processes in the m/n

# format. The last column displays the last process ID used.

return $load[0] || 0;

}

# additional checks for load average should go here for things that don't export

# /proc/loadavg

return 0;

}

# version of the core git binary

our $git_version;

sub evaluate_git_version {

our $git_version = qx("$GIT" --version) =~ m/git version (.*)$/ ? $1 : "unknown";

$number_of_git_cmds++;

}

sub check_loadavg {

if (defined $maxload && get_loadavg() > $maxload) {

die_error(503, "The load average on the server is too high");

}

# ======================================================================

# input validation and dispatch

# Various hash size-related values.

my $sha1_len = 40;

my $sha256_extra_len = 24;

my $sha256_len = $sha1_len + $sha256_extra_len;

# A regex matching $len hex characters. $len may be a range (e.g. 7,64).

sub oid_nlen_regex {

my $len = shift;

my $hchr = qr/[0-9a-fA-F]/;

return qr/(?:(?:$hchr){$len})/;

}

# A regex matching two sets of $nlen hex characters, prefixed by the literal

# string $prefix and with the literal string $infix between them.

sub oid_nlen_prefix_infix_regex {

my $nlen = shift;

my $prefix = shift;

my $infix = shift;

my $rx = oid_nlen_regex($nlen);

return qr/^\Q$prefix\E$rx\Q$infix\E$rx$/;

}

# A regex matching a valid object ID.

our $oid_regex;

{

my $x = oid_nlen_regex($sha1_len);

my $y = oid_nlen_regex($sha256_extra_len);

$oid_regex = qr/(?:$x(?:$y)?)/;

}

# input parameters can be collected from a variety of sources (presently, CGI

# and PATH_INFO), so we define an %input_params hash that collects them all

# together during validation: this allows subsequent uses (e.g. href()) to be

# agnostic of the parameter origin

our %input_params = ();

# input parameters are stored with the long parameter name as key. This will

# also be used in the href subroutine to convert parameters to their CGI

# equivalent, and since the href() usage is the most frequent one, we store

# the name -> CGI key mapping here, instead of the reverse.

# XXX: Warning: If you touch this, check the search form for updating,

# too.

our @cgi_param_mapping = (

project => "p",

action => "a",

file_name => "f",

file_parent => "fp",

hash => "h",

hash_parent => "hp",

hash_base => "hb",

hash_parent_base => "hpb",

page => "pg",

order => "o",

searchtext => "s",

searchtype => "st",

snapshot_format => "sf",

extra_options => "opt",

search_use_regexp => "sr",

ctag => "by_tag",

diff_style => "ds",

project_filter => "pf",

# this must be last entry (for manipulation from JavaScript)

javascript => "js"

);

our %cgi_param_mapping = @cgi_param_mapping;

# we will also need to know the possible actions, for validation

our %actions = (

"blame" => \&git_blame,

"blame_incremental" => \&git_blame_incremental,

"blame_data" => \&git_blame_data,

"blobdiff" => \&git_blobdiff,

"blobdiff_plain" => \&git_blobdiff_plain,

"blob" => \&git_blob,

"blob_plain" => \&git_blob_plain,

"commitdiff" => \&git_commitdiff,

"commitdiff_plain" => \&git_commitdiff_plain,

"commit" => \&git_commit,

"forks" => \&git_forks,

"heads" => \&git_heads,

"history" => \&git_history,

"log" => \&git_log,

"patch" => \&git_patch,

"patches" => \&git_patches,

"remotes" => \&git_remotes,

"rss" => \&git_rss,

"atom" => \&git_atom,

"search" => \&git_search,

"search_help" => \&git_search_help,

"shortlog" => \&git_shortlog,

"summary" => \&git_summary,

"tag" => \&git_tag,

"tags" => \&git_tags,

"tree" => \&git_tree,

"snapshot" => \&git_snapshot,

"object" => \&git_object,

# those below don't need $project

"opml" => \&git_opml,

"project_list" => \&git_project_list,

"project_index" => \&git_project_index,

);

# finally, we have the hash of allowed extra_options for the commands that

# allow them

our %allowed_options = (

"--no-merges" => [ qw(rss atom log shortlog history) ],

);

# fill %input_params with the CGI parameters. All values except for 'opt'

# should be single values, but opt can be an array. We should probably

# build an array of parameters that can be multi-valued, but since for the time

# being it's only this one, we just single it out

sub evaluate_query_params {

our $cgi;

while (my ($name, $symbol) = each %cgi_param_mapping) {

if ($symbol eq 'opt') {

$input_params{$name} = [ map { decode_utf8($_) } $cgi->multi_param($symbol) ];

} else {

$input_params{$name} = decode_utf8($cgi->param($symbol));

}

# now read PATH_INFO and update the parameter list for missing parameters

sub evaluate_path_info {

return if defined $input_params{'project'};

return if !$path_info;

$path_info =~ s,^/+,,;

return if !$path_info;

# find which part of PATH_INFO is project

my $project = $path_info;

$project =~ s,/+$,,;

while ($project && !check_head_link("$projectroot/$project")) {

$project =~ s,/*[^/]*$,,;

}

return unless $project;

$input_params{'project'} = $project;

# do not change any parameters if an action is given using the query string

return if $input_params{'action'};

$path_info =~ s,^\Q$project\E/*,,;

# next, check if we have an action

my $action = $path_info;

$action =~ s,/.*$,,;

if (exists $actions{$action}) {

$path_info =~ s,^$action/*,,;

$input_params{'action'} = $action;

}

# list of actions that want hash_base instead of hash, but can have no

# pathname (f) parameter

my @wants_base = (

'tree',

'history',

);

# we want to catch, among others

# [$hash_parent_base[:$file_parent]..]$hash_parent[:$file_name]

my ($parentrefname, $parentpathname, $refname, $pathname) =

($path_info =~ /^(?:(.+?)(?::(.+))?\.\.)?([^:]+?)?(?::(.+))?$/);

# first, analyze the 'current' part

if (defined $pathname) {

# we got "branch:filename" or "branch:dir/"

# we could use git_get_type(branch:pathname), but:

# - it needs $git_dir

# - it does a git() call

# - the convention of terminating directories with a slash

# makes it superfluous

# - embedding the action in the PATH_INFO would make it even

# more superfluous

$pathname =~ s,^/+,,;

if (!$pathname || substr($pathname, -1) eq "/") {

$input_params{'action'} ||= "tree";

$pathname =~ s,/$,,;

} else {

# the default action depends on whether we had parent info

# or not

if ($parentrefname) {

$input_params{'action'} ||= "blobdiff_plain";

} else {

$input_params{'action'} ||= "blob_plain";

}

$input_params{'hash_base'} ||= $refname;

$input_params{'file_name'} ||= $pathname;

} elsif (defined $refname) {

# we got "branch". In this case we have to choose if we have to

# set hash or hash_base.

# Most of the actions without a pathname only want hash to be

View remainder of file in raw view

git.github.io/gitweb/gitweb.perl at next · USDOS/git.github.io · GitHub

Navigation Menu

Uh oh!

git.github.io/gitweb/gitweb.perl at next · USDOS/git.github.io · GitHub

Navigation Menu

Uh oh!

Expand file tree

Breadcrumbs

gitweb.perl

Latest commit

History

Breadcrumbs

gitweb.perl

File metadata and controls

Footer

Footer navigation