FilesExpand file tree

main

/

protocol.ts

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

210 lines (174 loc) · 5.48 KB

main

/

protocol.ts

Copy path

Top

File metadata and controls

• Code
• Blame

210 lines (174 loc) · 5.48 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

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

/*---------------------------------------------------------------------------------------------

* Copyright (c) Microsoft Corporation. All rights reserved.

* Licensed under the MIT License. See License.txt in the project root for license information.

*--------------------------------------------------------------------------------------------*/

import * as vscode from 'vscode';

import Logger from './logger';

import { resolve } from '../env/node/ssh';

export enum ProtocolType {

Local,

HTTP,

SSH,

GIT,

OTHER,

}

export class Protocol {

private static readonly ID = 'Protocol';

public type: ProtocolType = ProtocolType.OTHER;

public host: string = '';

public owner: string = '';

public repositoryName: string = '';

public get nameWithOwner(): string {

return this.owner ? `${this.owner}/${this.repositoryName}` : this.repositoryName;

}

public readonly url: vscode.Uri;

constructor(uriString: string) {

if (this.parseSshProtocol(uriString)) {

this.url = vscode.Uri.from({ scheme: 'ssh', authority: this.host, path: `/${this.nameWithOwner}` });

return;

}

try {

this.url = vscode.Uri.parse(uriString);

this.type = this.getType(this.url.scheme);

this.host = this.getHostName(this.url.authority);

if (this.host) {

this.repositoryName = this.getRepositoryName(this.url.path) || '';

this.owner = this.getOwnerName(this.url.path) || '';

}

} catch (e) {

Logger.error(`Failed to parse '${uriString}'`, Protocol.ID);

vscode.window.showWarningMessage(

vscode.l10n.t('Unable to parse remote \'{0}\'. Please check that it is correctly formatted.', uriString)

);

}

}

private getType(scheme: string): ProtocolType {

switch (scheme) {

case 'file':

return ProtocolType.Local;

case 'http':

case 'https':

return ProtocolType.HTTP;

case 'git':

return ProtocolType.GIT;

case 'ssh':

return ProtocolType.SSH;

default:

return ProtocolType.OTHER;

}

}

private parseSshProtocol(uriString: string): boolean {

const sshConfig = resolve(uriString);

if (!sshConfig) {

return false;

}

const { Hostname, HostName, path } = sshConfig;

this.host = HostName || Hostname;

this.owner = this.getOwnerName(path) || '';

this.repositoryName = this.getRepositoryName(path) || '';

this.type = ProtocolType.SSH;

return true;

}

getHostName(authority: string) {

// <username>:<password>@<authority>:<port>

const matches = /^(?:.*:?@)?([^:]*)(?::.*)?$/.exec(authority);

if (matches && matches.length >= 2) {

// normalize to fix #903.

// www.github.com will redirect anyways, so this is safe in this specific case, but potentially not in others.

return matches[1].toLocaleLowerCase() === 'www.github.com' ? 'github.com' : matches[1];

}

return '';

}

getRepositoryName(path: string) {

let normalized = path.replace(/\\/g, '/');

if (normalized.endsWith('/')) {

normalized = normalized.substr(0, normalized.length - 1);

}

const lastIndex = normalized.lastIndexOf('/');

const lastSegment = normalized.substr(lastIndex + 1);

if (lastSegment === '' || lastSegment === '/') {

return;

}

return lastSegment.replace(/\/$/, '').replace(/\.git$/, '');

}

getOwnerName(path: string) {

let normalized = path.replace(/\\/g, '/');

if (normalized.endsWith('/')) {

normalized = normalized.substr(0, normalized.length - 1);

}

const fragments = normalized.split('/');

if (fragments.length > 1) {

return fragments[fragments.length - 2];

}

return;

}

normalizeUri(): vscode.Uri | undefined {

if (this.type === ProtocolType.OTHER && !this.url) {

return;

}

if (this.type === ProtocolType.Local) {

return this.url;

}

let scheme = 'https';

if (this.url && (this.url.scheme === 'http' || this.url.scheme === 'https')) {

scheme = this.url.scheme;

}

try {

return vscode.Uri.parse(

`${scheme}://${this.host.toLocaleLowerCase()}/${this.nameWithOwner.toLocaleLowerCase()}`,

);

} catch (e) {

return;

}

}

toString(): string | undefined {

// based on Uri scheme for SSH https://tools.ietf.org/id/draft-salowey-secsh-uri-00.html#anchor1 and heuristics of how GitHub handles ssh url

// sshUri = `ssh:`

// - omitted

// hier-part = "//" authority path-abempty

// - // is omitted

// authority = [ [ ssh-info ] "@" host ] [ ":" port]

// - ssh-info: git

// - host: ${this.host}

// - port: omitted

// path-abempty = <as specified in [RFC3986]>

// - we use relative path here `${this.owner}/${this.repositoryName}`

if (this.type === ProtocolType.SSH) {

return `git@${this.host}:${this.owner}/${this.repositoryName}`;

}

if (this.type === ProtocolType.GIT) {

return `git://git@${this.host}:${this.owner}/${this.repositoryName}`;

}

const normalizedUri = this.normalizeUri();

if (normalizedUri) {

return normalizedUri.toString();

}

return;

}

update(change: { type?: ProtocolType; host?: string; owner?: string; repositoryName?: string }): Protocol {

if (change.type) {

this.type = change.type;

}

if (change.host) {

this.host = change.host;

}

if (change.owner) {

this.owner = change.owner;

}

if (change.repositoryName) {

this.repositoryName = change.repositoryName;

}

return this;

}

equals(other: Protocol) {

const normalizeUri = this.normalizeUri();

if (!normalizeUri) {

return false;

}

const otherNormalizeUri = other.normalizeUri();

if (!otherNormalizeUri) {

return false;

}

return normalizeUri.toString().toLocaleLowerCase() === otherNormalizeUri.toString().toLocaleLowerCase();

}

}