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 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
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
//! System hook structures
//!
//! These hooks are received from Gitlab when registered as a system hook in the administrator
//! settings. Only administrators may create such hooks.
//!
//! Gitlab does not have consistent structures for its hooks, so they often change from
//! version to version.
use chrono::{DateTime, Utc};
use log::error;
use serde::de::{Error, Unexpected};
use serde::{Deserialize, Deserializer};
use serde_json::{self, Value};
use crate::webhooks::{CommitHookAttrs, ProjectHookAttrs};
/// Events which occur at the project level.
#[derive(Deserialize, Debug, Clone, Copy, PartialEq, Eq)]
pub enum ProjectEvent {
/// A project was created.
#[serde(rename = "project_create")]
Create,
/// A project was deleted.
#[serde(rename = "project_destroy")]
Destroy,
/// A project was renamed.
#[serde(rename = "project_rename")]
Rename,
/// A project moved from one namespace to another.
#[serde(rename = "project_transfer")]
Transfer,
/// An attribute of a project has changed
#[serde(rename = "project_update")]
Update,
}
/// Visibility levels for projects.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ProjectVisibility {
/// The project is only visible to users who are logged in.
Internal,
/// The project is only visible to team members.
Private,
/// The project is visible to everyone.
Public,
}
enum_serialize!(ProjectVisibility -> "project visibility",
Internal => "internal" ; "visibilitylevel|internal",
Private => "private" ; "visibilitylevel|private",
Public => "public" ; "visibilitylevel|public",
);
/// A hook for a project.
#[derive(Deserialize, Debug, Clone)]
pub struct ProjectSystemHook {
/// The event which occurred.
pub event_name: ProjectEvent,
/// When the project was created.
pub created_at: DateTime<Utc>,
/// When the project was last updated.
pub updated_at: DateTime<Utc>,
/// The display name of the project.
pub name: String,
/// The email address of the owner.
pub owner_email: String,
/// The name of the owner.
pub owner_name: String,
/// The path of the project (used for URLs).
pub path: String,
/// The namespace and path of the project.
pub path_with_namespace: String,
/// The ID of the project.
pub project_id: u64,
/// The visibility level of the project.
pub project_visibility: ProjectVisibility,
/// The old namespace and path of the project for `Rename` and `Transfer` events.
pub old_path_with_namespace: Option<String>,
}
/// Events which occur when users are added and removed from projects.
#[derive(Deserialize, Debug, Clone, Copy, PartialEq, Eq)]
pub enum ProjectMemberEvent {
/// A user was added to a project.
#[serde(rename = "user_add_to_team")]
Add,
/// A user was removed from a project.
#[serde(rename = "user_remove_from_team")]
Remove,
}
/// Access levels for groups and projects.
#[derive(Deserialize, Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
pub enum HumanAccessLevel {
/// Guest access (can see the project).
Guest,
/// Reporter access (can open issues).
Reporter,
/// Developer access (can push branches, handle issues and merge requests).
Developer,
/// Maintainer access (can push to protected branches).
Maintainer,
/// Owner access (full rights).
Owner,
}
/// A project membership hook.
#[derive(Deserialize, Debug, Clone)]
pub struct ProjectMemberSystemHook {
/// The event which occurred.
pub event_name: ProjectMemberEvent,
/// When the membership was created.
pub created_at: DateTime<Utc>,
/// When the membership was last updated.
pub updated_at: DateTime<Utc>,
/// The name of the project.
pub project_name: String,
/// The path of the project (used for URLs).
pub project_path: String,
/// The namespace and path of the project (used for URLs).
pub project_path_with_namespace: String,
/// The ID of the project.
pub project_id: u64,
/// The username of the user added as a member.
pub user_username: String,
/// The name of the user added as a member.
pub user_name: String,
/// The email address of the user added as a member.
pub user_email: String,
/// The ID of the user.
pub user_id: u64,
/// The access level granted to the user.
pub access_level: HumanAccessLevel,
/// The visibility of the project.
pub project_visibility: ProjectVisibility,
}
/// Events which occur for user accounts.
#[derive(Deserialize, Debug, Clone, Copy, PartialEq, Eq)]
pub enum UserEvent {
/// The user account was created.
#[serde(rename = "user_create")]
Create,
/// The user account was deleted.
#[serde(rename = "user_destroy")]
Destroy,
}
/// A user hook.
#[derive(Deserialize, Debug, Clone)]
pub struct UserSystemHook {
/// The event which occurred.
pub event_name: UserEvent,
/// When the user account was created.
pub created_at: DateTime<Utc>,
/// When the user account was last updated.
pub updated_at: DateTime<Utc>,
/// The name of the user.
pub name: String,
/// The email address of the user.
pub email: String,
/// The ID of the user.
pub user_id: u64,
/// The username of the user.
pub username: String,
}
/// Events which occur for SSH keys.
#[derive(Deserialize, Debug, Clone, Copy, PartialEq, Eq)]
pub enum KeyEvent {
/// An SSH key was uploaded.
#[serde(rename = "key_create")]
Create,
/// An SSH key was deleted.
#[serde(rename = "key_destroy")]
Destroy,
}
/// An SSH key hook.
#[derive(Deserialize, Debug, Clone)]
pub struct KeySystemHook {
/// The event which occurred.
pub event_name: KeyEvent,
/// When the key was added.
pub created_at: DateTime<Utc>,
/// When the key was last updated.
pub updated_at: DateTime<Utc>,
/// The username of the user.
pub username: String,
/// The content of the key.
pub key: String,
/// The ID of the key.
pub id: u64,
}
/// Events which occur for groups.
#[derive(Deserialize, Debug, Clone, Copy, PartialEq, Eq)]
pub enum GroupEvent {
/// The group was created.
#[serde(rename = "group_create")]
Create,
/// The group was deleted.
#[serde(rename = "group_destrpy")]
Destroy,
}
/// A group hook.
#[derive(Deserialize, Debug, Clone)]
pub struct GroupSystemHook {
/// The event which occurred.
pub event_name: GroupEvent,
/// When the group was created.
pub created_at: DateTime<Utc>,
/// When the group was last updated.
pub updated_at: DateTime<Utc>,
/// The name of the group.
pub name: String,
/// The path of the group (used for URLs).
pub path: String,
/// The ID of the group.
pub group_id: u64,
/// The email address of the owner of the group.
pub owner_email: Option<String>,
/// The name of the owner of the group.
pub owner_name: Option<String>,
}
/// Events which occur for group memberships.
#[derive(Deserialize, Debug, Clone, Copy, PartialEq, Eq)]
pub enum GroupMemberEvent {
/// A user was added to the group.
#[serde(rename = "user_add_to_group")]
Add,
/// A user was removed from the group.
#[serde(rename = "user_remove_from_group")]
Remove,
}
/// A group membership hook.
#[derive(Deserialize, Debug, Clone)]
pub struct GroupMemberSystemHook {
/// The event which occurred.
pub event_name: GroupMemberEvent,
/// When the group membership was added.
pub created_at: DateTime<Utc>,
/// When the group membership was last updated.
pub updated_at: DateTime<Utc>,
/// The name of the group.
pub group_name: String,
/// The path of the group (used for URLs).
pub group_path: String,
/// The ID of the group.
pub group_id: u64,
/// The username of the user.
pub user_username: String,
/// The name of the user.
pub user_name: String,
/// The email address of the user.
pub user_email: String,
/// The ID of the user.
pub user_id: u64,
/// The access level of the user.
pub group_access: HumanAccessLevel,
}
/// Events which occur when a push happens.
#[derive(Deserialize, Debug, Clone, Copy, PartialEq, Eq)]
pub enum PushEvent {
/// A non-tag push occurred.
#[serde(rename = "push")]
Push,
/// A tag was pushed.
#[serde(rename = "tag_push")]
TagPush,
}
/// A push hook.
#[derive(Deserialize, Debug, Clone)]
pub struct PushSystemHook {
/// The event which occurred.
pub event_name: PushEvent,
/// When the push occurred.
pub created_at: DateTime<Utc>,
/// When the push
pub updated_at: DateTime<Utc>,
/// The old object ID of the ref that was pushed.
pub before: String,
/// The new object ID of the ref that was pushed.
pub after: String,
#[serde(rename = "ref")]
/// The name of the reference that was pushed.
pub ref_: String,
/// The new object ID of the ref that was pushed.
pub checkout_sha: String,
/// The message for the push (used for annotated tags).
pub message: Option<String>,
/// The ID of the user who pushed.
pub user_id: u64,
/// The name of the user who pushed.
pub user_name: String,
/// The email address of the user who pushed.
pub user_email: String,
/// The URL of the user's avatar.
pub user_avatar: String,
/// The ID of the project pushed to.
pub project_id: u64,
/// Attributes of the project.
pub project: ProjectHookAttrs,
/// The commits pushed to the repository.
///
/// Limited to 20 commits.
pub commits: Vec<CommitHookAttrs>,
/// The total number of commits pushed.
pub total_commits_count: u64,
}
/// A deserializable structure for all Gitlab system hooks.
#[derive(Debug, Clone)]
pub enum SystemHook {
/// A project hook.
Project(ProjectSystemHook),
/// A project membership hook.
ProjectMember(ProjectMemberSystemHook),
/// A user account hook.
User(UserSystemHook),
/// An SSH key hook.
Key(KeySystemHook),
/// A group hook.
Group(GroupSystemHook),
/// A group membership hook.
GroupMember(GroupMemberSystemHook),
/// A push hook.
Push(Box<PushSystemHook>),
}
impl<'de> Deserialize<'de> for SystemHook {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: Deserializer<'de>,
{
let val = <Value as Deserialize>::deserialize(deserializer)?;
let event_name = match val.pointer("/event_name") {
Some(Value::String(name)) => name,
Some(_) => {
return Err(D::Error::invalid_type(
Unexpected::Other("JSON value"),
&"a string",
));
},
None => {
return Err(D::Error::missing_field("event_name"));
},
};
let hook_res = match event_name.as_ref() {
"project_create" | "project_destroy" | "project_rename" | "project_transfer"
| "project_update" => serde_json::from_value(val).map(SystemHook::Project),
"user_add_to_team" | "user_remove_from_team" => {
serde_json::from_value(val).map(SystemHook::ProjectMember)
},
"user_create" | "user_destroy" => serde_json::from_value(val).map(SystemHook::User),
"key_create" | "key_destroy" => serde_json::from_value(val).map(SystemHook::Key),
"group_create" | "group_destroy" => serde_json::from_value(val).map(SystemHook::Group),
"user_add_to_group" | "user_remove_from_group" => {
serde_json::from_value(val).map(SystemHook::GroupMember)
},
"push" | "tag_push" => {
serde_json::from_value(val).map(|hook| SystemHook::Push(Box::new(hook)))
},
_ => {
return Err(D::Error::custom(format!(
"unrecognized system event name: {}",
event_name,
)));
},
};
hook_res.map_err(|err| {
D::Error::custom(format!("failed to deserialize a system hook: {:?}", err))
})
}
}