python-github-backup/github_backup/github_backup.py at master · theSage21/python-github-backup · GitHub

History

1156 lines (978 loc) · 43.7 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/env python

from __future__ import print_function

import socket

import argparse

import base64

import calendar

import codecs

import datetime

import errno

import getpass

import json

import logging

import os

import re

import select

import subprocess

import sys

import time

import platform

PY2 = False

try:

# python 3

from urllib.parse import urlparse

from urllib.parse import quote as urlquote

from urllib.parse import urlencode

from urllib.error import HTTPError, URLError

from urllib.request import urlopen

from urllib.request import Request

from urllib.request import HTTPRedirectHandler

from urllib.request import build_opener

except ImportError:

# python 2

PY2 = True

from urlparse import urlparse

from urllib import quote as urlquote

from urllib import urlencode

from urllib2 import HTTPError, URLError

from urllib2 import urlopen

from urllib2 import Request

from urllib2 import HTTPRedirectHandler

from urllib2 import build_opener

try:

from . import __version__

VERSION = __version__

except ImportError:

VERSION = 'unknown'

FNULL = open(os.devnull, 'w')

def _get_log_date():

return datetime.datetime.isoformat(datetime.datetime.now())

def log_error(message):

"""

Log message (str) or messages (List[str]) to stderr and exit with status 1

"""

log_warning(message)

sys.exit(1)

def log_info(message):

"""

Log message (str) or messages (List[str]) to stdout

"""

if type(message) == str:

message = [message]

for msg in message:

sys.stdout.write("{0}: {1}\n".format(_get_log_date(), msg))

def log_warning(message):

"""

Log message (str) or messages (List[str]) to stderr

"""

if type(message) == str:

message = [message]

for msg in message:

sys.stderr.write("{0}: {1}\n".format(_get_log_date(), msg))

def logging_subprocess(popenargs,

logger,

stdout_log_level=logging.DEBUG,

stderr_log_level=logging.ERROR,

**kwargs):

"""

Variant of subprocess.call that accepts a logger instead of stdout/stderr,

and logs stdout messages via logger.debug and stderr messages via

logger.error.

"""

child = subprocess.Popen(popenargs, stdout=subprocess.PIPE,

stderr=subprocess.PIPE, **kwargs)

if sys.platform == 'win32':

log_info("Windows operating system detected - no subprocess logging will be returned")

log_level = {child.stdout: stdout_log_level,

child.stderr: stderr_log_level}

def check_io():

if sys.platform == 'win32':

return

ready_to_read = select.select([child.stdout, child.stderr],

[],

1000)[0]

for io in ready_to_read:

line = io.readline()

if not logger:

continue

if not (io == child.stderr and not line):

logger.log(log_level[io], line[:-1])

# keep checking stdout/stderr until the child exits

while child.poll() is None:

check_io()

check_io() # check again to catch anything after the process exits

rc = child.wait()

if rc != 0:

print('{} returned {}:'.format(popenargs[0], rc), file=sys.stderr)

print('\t', ' '.join(popenargs), file=sys.stderr)

return rc

def mkdir_p(*args):

for path in args:

try:

os.makedirs(path)

except OSError as exc: # Python >2.5

if exc.errno == errno.EEXIST and os.path.isdir(path):

pass

else:

raise

def mask_password(url, secret='*****'):

parsed = urlparse(url)

if not parsed.password:

return url

elif parsed.password == 'x-oauth-basic':

return url.replace(parsed.username, secret)

return url.replace(parsed.password, secret)

def parse_args():

parser = argparse.ArgumentParser(description='Backup a github account')

parser.add_argument('user',

metavar='USER',

type=str,

help='github username')

parser.add_argument('-u',

'--username',

dest='username',

help='username for basic auth')

parser.add_argument('-p',

'--password',

dest='password',

help='password for basic auth. '

'If a username is given but not a password, the '

'password will be prompted for.')

parser.add_argument('-t',

'--token',

dest='token',

help='personal access, OAuth, or JSON Web token, or path to token (file://...)') # noqa

parser.add_argument('--as-app',

action='store_true',

dest='as_app',

help='authenticate as github app instead of as a user.')

parser.add_argument('-o',

'--output-directory',

default='.',

dest='output_directory',

help='directory at which to backup the repositories')

parser.add_argument('-i',

'--incremental',

action='store_true',

dest='incremental',

help='incremental backup')

parser.add_argument('--starred',

action='store_true',

dest='include_starred',

help='include JSON output of starred repositories in backup')

parser.add_argument('--all-starred',

action='store_true',

dest='all_starred',

help='include starred repositories in backup [*]')

parser.add_argument('--watched',

action='store_true',

dest='include_watched',

help='include JSON output of watched repositories in backup')

parser.add_argument('--followers',

action='store_true',

dest='include_followers',

help='include JSON output of followers in backup')

parser.add_argument('--following',

action='store_true',

dest='include_following',

help='include JSON output of following users in backup')

parser.add_argument('--all',

action='store_true',

dest='include_everything',

help='include everything in backup (not including [*])')

parser.add_argument('--issues',

action='store_true',

dest='include_issues',

help='include issues in backup')

parser.add_argument('--issue-comments',

action='store_true',

dest='include_issue_comments',

help='include issue comments in backup')

parser.add_argument('--issue-events',

action='store_true',

dest='include_issue_events',

help='include issue events in backup')

parser.add_argument('--pulls',

action='store_true',

dest='include_pulls',

help='include pull requests in backup')

parser.add_argument('--pull-comments',

action='store_true',

dest='include_pull_comments',

help='include pull request review comments in backup')

parser.add_argument('--pull-commits',

action='store_true',

dest='include_pull_commits',

help='include pull request commits in backup')

parser.add_argument('--pull-details',

action='store_true',

dest='include_pull_details',

help='include more pull request details in backup [*]')

parser.add_argument('--labels',

action='store_true',

dest='include_labels',

help='include labels in backup')

parser.add_argument('--hooks',

action='store_true',

dest='include_hooks',

help='include hooks in backup (works only when authenticated)') # noqa

parser.add_argument('--milestones',

action='store_true',

dest='include_milestones',

help='include milestones in backup')

parser.add_argument('--repositories',

action='store_true',

dest='include_repository',

help='include repository clone in backup')

parser.add_argument('--bare',

action='store_true',

dest='bare_clone',

help='clone bare repositories')

parser.add_argument('--lfs',

action='store_true',

dest='lfs_clone',

help='clone LFS repositories (requires Git LFS to be installed, https://git-lfs.github.com) [*]')

parser.add_argument('--wikis',

action='store_true',

dest='include_wiki',

help='include wiki clone in backup')

parser.add_argument('--gists',

action='store_true',

dest='include_gists',

help='include gists in backup [*]')

parser.add_argument('--starred-gists',

action='store_true',

dest='include_starred_gists',

help='include starred gists in backup [*]')

parser.add_argument('--skip-existing',

action='store_true',

dest='skip_existing',

help='skip project if a backup directory exists')

parser.add_argument('-L',

'--languages',

dest='languages',

help='only allow these languages',

nargs='*')

parser.add_argument('-N',

'--name-regex',

dest='name_regex',

help='python regex to match names against')

parser.add_argument('-H',

'--github-host',

dest='github_host',

help='GitHub Enterprise hostname')

parser.add_argument('-O',

'--organization',

action='store_true',

dest='organization',

help='whether or not this is an organization user')

parser.add_argument('-R',

'--repository',

dest='repository',

help='name of repository to limit backup to')

parser.add_argument('-P', '--private',

action='store_true',

dest='private',

help='include private repositories [*]')

parser.add_argument('-F', '--fork',

action='store_true',

dest='fork',

help='include forked repositories [*]')

parser.add_argument('--prefer-ssh',

action='store_true',

help='Clone repositories using SSH instead of HTTPS')

parser.add_argument('-v', '--version',

action='version',

version='%(prog)s ' + VERSION)

parser.add_argument('--keychain-name',

dest='osx_keychain_item_name',

help='OSX ONLY: name field of password item in OSX keychain that holds the personal access or OAuth token')

parser.add_argument('--keychain-account',

dest='osx_keychain_item_account',

help='OSX ONLY: account field of password item in OSX keychain that holds the personal access or OAuth token')

parser.add_argument('--releases',

action='store_true',

dest='include_releases',

help='include release information, not including assets or binaries'

)

parser.add_argument('--assets',

action='store_true',

dest='include_assets',

help='include assets alongside release information; only applies if including releases')

parser.add_argument('--throttle-limit',

dest='throttle_limit',

type=int,

default=0,

help='start throttling of GitHub API requests after this amount of API requests remain')

parser.add_argument('--throttle-pause',

dest='throttle_pause',

type=float,

default=30.0,

help='wait this amount of seconds when API request throttling is active (default: 30.0, requires --throttle-limit to be set)')

return parser.parse_args()

def get_auth(args, encode=True, for_git_cli=False):

auth = None

if args.osx_keychain_item_name:

if not args.osx_keychain_item_account:

log_error('You must specify both name and account fields for osx keychain password items')

else:

if platform.system() != 'Darwin':

log_error("Keychain arguments are only supported on Mac OSX")

try:

with open(os.devnull, 'w') as devnull:

token = (subprocess.check_output([

'security', 'find-generic-password',

'-s', args.osx_keychain_item_name,

'-a', args.osx_keychain_item_account,

'-w'], stderr=devnull).strip())

if not PY2:

token = token.decode('utf-8')

auth = token + ':' + 'x-oauth-basic'

except:

log_error('No password item matching the provided name and account could be found in the osx keychain.')

elif args.osx_keychain_item_account:

log_error('You must specify both name and account fields for osx keychain password items')

elif args.token:

_path_specifier = 'file://'

if args.token.startswith(_path_specifier):

args.token = open(args.token[len(_path_specifier):],

'rt').readline().strip()

if not args.as_app:

auth = args.token + ':' + 'x-oauth-basic'

else:

if not for_git_cli:

auth = args.token

else:

auth = 'x-access-token:' + args.token

elif args.username:

if not args.password:

args.password = getpass.getpass()

if encode:

password = args.password

else:

password = urlquote(args.password)

auth = args.username + ':' + password

elif args.password:

log_error('You must specify a username for basic auth')

if not auth:

return None

if not encode:

return auth

return base64.b64encode(auth.encode('ascii'))

def get_github_api_host(args):

if args.github_host:

host = args.github_host + '/api/v3'

else:

host = 'api.github.com'

return host

def get_github_host(args):

if args.github_host:

host = args.github_host

else:

host = 'github.com'

return host

def get_github_repo_url(args, repository):

if repository.get('is_gist'):

return repository['git_pull_url']

if args.prefer_ssh:

return repository['ssh_url']

auth = get_auth(args, encode=False, for_git_cli=True)

if auth and repository['private'] == True:

repo_url = 'https://{0}@{1}/{2}/{3}.git'.format(

auth,

get_github_host(args),

repository['owner']['login'],

repository['name'])

else:

repo_url = repository['clone_url']

return repo_url

def retrieve_data_gen(args, template, query_args=None, single_request=False):

auth = get_auth(args, encode=not args.as_app)

query_args = get_query_args(query_args)

per_page = 100

page = 0

while True:

page = page + 1

request = _construct_request(per_page, page, query_args, template, auth, as_app=args.as_app) # noqa

r, errors = _get_response(request, auth, template)

status_code = int(r.getcode())

# be gentle with API request limit and throttle requests if remaining requests getting low

limit_remaining = int(r.headers.get('x-ratelimit-remaining', 0))

if limit_remaining <= args.throttle_limit:

log_info(

'API request limit hit: {} requests left, pausing further requests for {}s'.format(

limit_remaining,

args.throttle_pause))

time.sleep(args.throttle_pause)

retries = 0

while retries < 3 and status_code == 502:

log_warning('API request returned HTTP 502: Bad Gateway. Retrying in 5 seconds')

retries += 1

time.sleep(5)

request = _construct_request(per_page, page, query_args, template, auth, as_app=args.as_app) # noqa

r, errors = _get_response(request, auth, template)

status_code = int(r.getcode())

if status_code != 200:

template = 'API request returned HTTP {0}: {1}'

errors.append(template.format(status_code, r.reason))

log_error(errors)

response = json.loads(r.read().decode('utf-8'))

if len(errors) == 0:

if type(response) == list:

for resp in response:

yield resp

if len(response) < per_page:

break

elif type(response) == dict and single_request:

yield response

if len(errors) > 0:

log_error(errors)

if single_request:

break

def retrieve_data(args, template, query_args=None, single_request=False):

return list(retrieve_data_gen(args, template, query_args, single_request))

def get_query_args(query_args=None):

if not query_args:

query_args = {}

return query_args

def _get_response(request, auth, template):

retry_timeout = 3

errors = []

# We'll make requests in a loop so we can

# delay and retry in the case of rate-limiting

while True:

should_continue = False

try:

r = urlopen(request)

except HTTPError as exc:

errors, should_continue = _request_http_error(exc, auth, errors) # noqa

r = exc

except URLError as e:

log_warning(e.reason)

should_continue = _request_url_error(template, retry_timeout)

if not should_continue:

raise

except socket.error as e:

log_warning(e.strerror)

should_continue = _request_url_error(template, retry_timeout)

if not should_continue:

raise

if should_continue:

continue

break

return r, errors

def _construct_request(per_page, page, query_args, template, auth, as_app=None):

querystring = urlencode(dict(list({

'per_page': per_page,

'page': page

}.items()) + list(query_args.items())))

request = Request(template + '?' + querystring)

if auth is not None:

if not as_app:

request.add_header('Authorization', 'Basic '.encode('ascii') + auth)

else:

if not PY2:

auth = auth.encode('ascii')

request.add_header('Authorization', 'token '.encode('ascii') + auth)

request.add_header('Accept', 'application/vnd.github.machine-man-preview+json')

log_info('Requesting {}?{}'.format(template, querystring))

return request

def _request_http_error(exc, auth, errors):

# HTTPError behaves like a Response so we can

# check the status code and headers to see exactly

# what failed.

should_continue = False

headers = exc.headers

limit_remaining = int(headers.get('x-ratelimit-remaining', 0))

if exc.code == 403 and limit_remaining < 1:

# The X-RateLimit-Reset header includes a

# timestamp telling us when the limit will reset

# so we can calculate how long to wait rather

# than inefficiently polling:

gm_now = calendar.timegm(time.gmtime())

reset = int(headers.get('x-ratelimit-reset', 0)) or gm_now

# We'll never sleep for less than 10 seconds:

delta = max(10, reset - gm_now)

limit = headers.get('x-ratelimit-limit')

log_warning('Exceeded rate limit of {} requests; waiting {} seconds to reset'.format(limit, delta)) # noqa

if auth is None:

log_info('Hint: Authenticate to raise your GitHub rate limit')

time.sleep(delta)

should_continue = True

return errors, should_continue

def _request_url_error(template, retry_timeout):

# Incase of a connection timing out, we can retry a few time

# But we won't crash and not back-up the rest now

log_info('{} timed out'.format(template))

retry_timeout -= 1

if retry_timeout >= 0:

return True

log_error('{} timed out to much, skipping!')

return False

class S3HTTPRedirectHandler(HTTPRedirectHandler):

"""

A subclassed redirect handler for downloading Github assets from S3.

urllib will add the Authorization header to the redirected request to S3, which will result in a 400,

so we should remove said header on redirect.

"""

def redirect_request(self, req, fp, code, msg, headers, newurl):

if PY2:

# HTTPRedirectHandler is an old style class

request = HTTPRedirectHandler.redirect_request(self, req, fp, code, msg, headers, newurl)

else:

request = super(S3HTTPRedirectHandler, self).redirect_request(req, fp, code, msg, headers, newurl)

del request.headers['Authorization']

return request

def download_file(url, path, auth):

# Skip downloading release assets if they already exist on disk so we don't redownload on every sync

if os.path.exists(path):

return

request = Request(url)

request.add_header('Accept', 'application/octet-stream')

request.add_header('Authorization', 'Basic '.encode('ascii') + auth)

opener = build_opener(S3HTTPRedirectHandler)

try:

response = opener.open(request)

chunk_size = 16 * 1024

with open(path, 'wb') as f:

while True:

chunk = response.read(chunk_size)

if not chunk:

break

f.write(chunk)

except HTTPError as exc:

# Gracefully handle 404 responses (and others) when downloading from S3

log_warning('Skipping download of asset {0} due to HTTPError: {1}'.format(url, exc.reason))

except URLError as e:

# Gracefully handle other URL errors

log_warning('Skipping download of asset {0} due to URLError: {1}'.format(url, e.reason))

except socket.error as e:

# Gracefully handle socket errors

# TODO: Implement retry logic

log_warning('Skipping download of asset {0} due to socker error: {1}'.format(url, e.strerror))

def get_authenticated_user(args):

template = 'https://{0}/user'.format(get_github_api_host(args))

data = retrieve_data(args, template, single_request=True)

return data[0]

def check_git_lfs_install():

exit_code = subprocess.call(['git', 'lfs', 'version'])

if exit_code != 0:

log_error('The argument --lfs requires you to have Git LFS installed.\nYou can get it from https://git-lfs.github.com.')

def retrieve_repositories(args, authenticated_user):

log_info('Retrieving repositories')

single_request = False

if args.user == authenticated_user['login']:

# we must use the /user/repos API to be able to access private repos

template = 'https://{0}/user/repos'.format(

get_github_api_host(args))

else:

if args.private and not args.organization:

log_warning('Authenticated user is different from user being backed up, thus private repositories cannot be accessed')

template = 'https://{0}/users/{1}/repos'.format(

get_github_api_host(args),

args.user)

if args.organization:

template = 'https://{0}/orgs/{1}/repos'.format(

get_github_api_host(args),

args.user)

if args.repository:

single_request = True

template = 'https://{0}/repos/{1}/{2}'.format(

get_github_api_host(args),

args.user,

args.repository)

repos = retrieve_data(args, template, single_request=single_request)

if args.all_starred:

starred_template = 'https://{0}/users/{1}/starred'.format(get_github_api_host(args), args.user)

starred_repos = retrieve_data(args, starred_template, single_request=False)

# flag each repo as starred for downstream processing

for item in starred_repos:

item.update({'is_starred': True})

repos.extend(starred_repos)

if args.include_gists:

gists_template = 'https://{0}/users/{1}/gists'.format(get_github_api_host(args), args.user)

gists = retrieve_data(args, gists_template, single_request=False)

# flag each repo as a gist for downstream processing

for item in gists:

item.update({'is_gist': True})

repos.extend(gists)

if args.include_starred_gists:

starred_gists_template = 'https://{0}/gists/starred'.format(get_github_api_host(args))

starred_gists = retrieve_data(args, starred_gists_template, single_request=False)

# flag each repo as a starred gist for downstream processing

for item in starred_gists:

item.update({'is_gist': True,

'is_starred': True})

repos.extend(starred_gists)

return repos

def filter_repositories(args, unfiltered_repositories):

log_info('Filtering repositories')

repositories = []

for r in unfiltered_repositories:

# gists can be anonymous, so need to safely check owner

if r.get('owner', {}).get('login') == args.user or r.get('is_starred'):

repositories.append(r)

name_regex = None

if args.name_regex:

name_regex = re.compile(args.name_regex)

languages = None

if args.languages:

languages = [x.lower() for x in args.languages]

if not args.fork:

repositories = [r for r in repositories if not r.get('fork')]

if not args.private:

repositories = [r for r in repositories if not r.get('private') or r.get('public')]

if languages:

repositories = [r for r in repositories if r.get('language') and r.get('language').lower() in languages] # noqa

if name_regex:

repositories = [r for r in repositories if name_regex.match(r['name'])]

return repositories

def backup_repositories(args, output_directory, repositories):

log_info('Backing up repositories')

repos_template = 'https://{0}/repos'.format(get_github_api_host(args))

if args.incremental:

last_update = max(list(repository['updated_at'] for repository in repositories) or [time.strftime('%Y-%m-%dT%H:%M:%SZ', time.localtime())]) # noqa

last_update_path = os.path.join(output_directory, 'last_update')

if os.path.exists(last_update_path):

args.since = open(last_update_path).read().strip()

else:

args.since = None

else:

args.since = None

for repository in repositories:

if repository.get('is_gist'):

repo_cwd = os.path.join(output_directory, 'gists', repository['id'])

elif repository.get('is_starred'):

# put starred repos in -o/starred/${owner}/${repo} to prevent collision of

# any repositories with the same name

repo_cwd = os.path.join(output_directory, 'starred', repository['owner']['login'], repository['name'])

else:

repo_cwd = os.path.join(output_directory, 'repositories', repository['name'])

repo_dir = os.path.join(repo_cwd, 'repository')

repo_url = get_github_repo_url(args, repository)

include_gists = (args.include_gists or args.include_starred_gists)

if (args.include_repository or args.include_everything) \

or (include_gists and repository.get('is_gist')):

repo_name = repository.get('name') if not repository.get('is_gist') else repository.get('id')

fetch_repository(repo_name,

repo_url,

repo_dir,

skip_existing=args.skip_existing,

bare_clone=args.bare_clone,

lfs_clone=args.lfs_clone)

if repository.get('is_gist'):

# dump gist information to a file as well

output_file = '{0}/gist.json'.format(repo_cwd)

with codecs.open(output_file, 'w', encoding='utf-8') as f:

json_dump(repository, f)

continue # don't try to back anything else for a gist; it doesn't exist

download_wiki = (args.include_wiki or args.include_everything)

if repository['has_wiki'] and download_wiki:

fetch_repository(repository['name'],

repo_url.replace('.git', '.wiki.git'),

os.path.join(repo_cwd, 'wiki'),

skip_existing=args.skip_existing,

bare_clone=args.bare_clone,

lfs_clone=args.lfs_clone)

if args.include_issues or args.include_everything:

backup_issues(args, repo_cwd, repository, repos_template)

if args.include_pulls or args.include_everything:

backup_pulls(args, repo_cwd, repository, repos_template)

if args.include_milestones or args.include_everything:

backup_milestones(args, repo_cwd, repository, repos_template)

if args.include_labels or args.include_everything:

backup_labels(args, repo_cwd, repository, repos_template)

if args.include_hooks or args.include_everything:

backup_hooks(args, repo_cwd, repository, repos_template)

if args.include_releases or args.include_everything:

backup_releases(args, repo_cwd, repository, repos_template,

include_assets=args.include_assets or args.include_everything)

if args.incremental:

open(last_update_path, 'w').write(last_update)

def backup_issues(args, repo_cwd, repository, repos_template):

has_issues_dir = os.path.isdir('{0}/issues/.git'.format(repo_cwd))

if args.skip_existing and has_issues_dir:

return

log_info('Retrieving {0} issues'.format(repository['full_name']))

issue_cwd = os.path.join(repo_cwd, 'issues')

mkdir_p(repo_cwd, issue_cwd)

issues = {}

issues_skipped = 0

issues_skipped_message = ''

_issue_template = '{0}/{1}/issues'.format(repos_template,

repository['full_name'])

should_include_pulls = args.include_pulls or args.include_everything

issue_states = ['open', 'closed']

for issue_state in issue_states:

query_args = {

'filter': 'all',

'state': issue_state

}

if args.since:

query_args['since'] = args.since

_issues = retrieve_data(args,

_issue_template,

query_args=query_args)

for issue in _issues:

# skip pull requests which are also returned as issues

# if retrieving pull requests is requested as well

if 'pull_request' in issue and should_include_pulls:

issues_skipped += 1

continue

issues[issue['number']] = issue

if issues_skipped:

issues_skipped_message = ' (skipped {0} pull requests)'.format(

issues_skipped)

log_info('Saving {0} issues to disk{1}'.format(

len(list(issues.keys())), issues_skipped_message))

comments_template = _issue_template + '/{0}/comments'

events_template = _issue_template + '/{0}/events'

for number, issue in list(issues.items()):

if args.include_issue_comments or args.include_everything:

template = comments_template.format(number)

issues[number]['comment_data'] = retrieve_data(args, template)

if args.include_issue_events or args.include_everything:

template = events_template.format(number)

issues[number]['event_data'] = retrieve_data(args, template)

issue_file = '{0}/{1}.json'.format(issue_cwd, number)

with codecs.open(issue_file, 'w', encoding='utf-8') as f:

json_dump(issue, f)

def backup_pulls(args, repo_cwd, repository, repos_template):

has_pulls_dir = os.path.isdir('{0}/pulls/.git'.format(repo_cwd))

if args.skip_existing and has_pulls_dir:

return

log_info('Retrieving {0} pull requests'.format(repository['full_name'])) # noqa

pulls_cwd = os.path.join(repo_cwd, 'pulls')

mkdir_p(repo_cwd, pulls_cwd)

pulls = {}

_pulls_template = '{0}/{1}/pulls'.format(repos_template,

repository['full_name'])

query_args = {

'filter': 'all',

'state': 'all',

'sort': 'updated',

'direction': 'desc',

}

if not args.include_pull_details:

pull_states = ['open', 'closed']

for pull_state in pull_states:

query_args['state'] = pull_state

_pulls = retrieve_data_gen(args,

_pulls_template,

query_args=query_args)

for pull in _pulls:

if args.since and pull['updated_at'] < args.since:

break

if not args.since or pull['updated_at'] >= args.since:

pulls[pull['number']] = pull

else:

_pulls = retrieve_data_gen(args,

_pulls_template,

query_args=query_args)

for pull in _pulls:

if args.since and pull['updated_at'] < args.since:

break

if not args.since or pull['updated_at'] >= args.since:

pulls[pull['number']] = retrieve_data(

args,

_pulls_template + '/{}'.format(pull['number']),

single_request=True

)[0]

log_info('Saving {0} pull requests to disk'.format(

len(list(pulls.keys()))))

comments_template = _pulls_template + '/{0}/comments'

commits_template = _pulls_template + '/{0}/commits'

for number, pull in list(pulls.items()):

if args.include_pull_comments or args.include_everything:

template = comments_template.format(number)

pulls[number]['comment_data'] = retrieve_data(args, template)

if args.include_pull_commits or args.include_everything:

template = commits_template.format(number)

pulls[number]['commit_data'] = retrieve_data(args, template)

pull_file = '{0}/{1}.json'.format(pulls_cwd, number)

with codecs.open(pull_file, 'w', encoding='utf-8') as f:

json_dump(pull, f)

def backup_milestones(args, repo_cwd, repository, repos_template):

milestone_cwd = os.path.join(repo_cwd, 'milestones')

if args.skip_existing and os.path.isdir(milestone_cwd):

return

log_info('Retrieving {0} milestones'.format(repository['full_name']))

mkdir_p(repo_cwd, milestone_cwd)

template = '{0}/{1}/milestones'.format(repos_template,

repository['full_name'])

query_args = {

'state': 'all'

}

_milestones = retrieve_data(args, template, query_args=query_args)

milestones = {}

for milestone in _milestones:

milestones[milestone['number']] = milestone

log_info('Saving {0} milestones to disk'.format(

len(list(milestones.keys()))))

for number, milestone in list(milestones.items()):

milestone_file = '{0}/{1}.json'.format(milestone_cwd, number)

with codecs.open(milestone_file, 'w', encoding='utf-8') as f:

json_dump(milestone, f)

def backup_labels(args, repo_cwd, repository, repos_template):

label_cwd = os.path.join(repo_cwd, 'labels')

output_file = '{0}/labels.json'.format(label_cwd)

template = '{0}/{1}/labels'.format(repos_template,

repository['full_name'])

_backup_data(args,

'labels',

template,

output_file,

label_cwd)

def backup_hooks(args, repo_cwd, repository, repos_template):

auth = get_auth(args)

if not auth:

log_info("Skipping hooks since no authentication provided")

return

hook_cwd = os.path.join(repo_cwd, 'hooks')

output_file = '{0}/hooks.json'.format(hook_cwd)

template = '{0}/{1}/hooks'.format(repos_template,

repository['full_name'])

try:

_backup_data(args,

'hooks',

template,

output_file,

hook_cwd)

except SystemExit:

log_info("Unable to read hooks, skipping")

def backup_releases(args, repo_cwd, repository, repos_template, include_assets=False):

repository_fullname = repository['full_name']

# give release files somewhere to live & log intent

View remainder of file in raw view

python-github-backup/github_backup/github_backup.py at master · theSage21/python-github-backup · GitHub

Expand file tree

Breadcrumbs

github_backup.py

Latest commit

History

Breadcrumbs

github_backup.py

File metadata and controls