package curseforge import ( "bytes" "encoding/base64" "encoding/json" "fmt" "github.com/packwiz/packwiz/core" "io" "net/http" "net/url" "strconv" "time" ) const cfApiServer = "api.curseforge.com" // If you fork/derive from packwiz, I request that you obtain your own API key. const cfApiKeyDefault = "JDJhJDEwJHNBWVhqblU1N0EzSmpzcmJYM3JVdk92UWk2NHBLS3BnQ2VpbGc1TUM1UGNKL0RYTmlGWWxh" // Exists so you can provide it as a build parameter: -ldflags="-X 'github.com/packwiz/packwiz/curseforge.cfApiKey=key'" var cfApiKey = "" func decodeDefaultKey() string { k, err := base64.StdEncoding.DecodeString(cfApiKeyDefault) if err != nil { panic("failed to read API key!") } return string(k) } type cfApiClient struct { httpClient *http.Client } var cfDefaultClient = cfApiClient{&http.Client{}} func (c *cfApiClient) makeGet(endpoint string) (*http.Response, error) { req, err := http.NewRequest("GET", "https://"+cfApiServer+endpoint, nil) if err != nil { return nil, err } req.Header.Set("User-Agent", core.UserAgent) req.Header.Set("Accept", "application/json") if cfApiKey == "" { cfApiKey = decodeDefaultKey() } req.Header.Set("X-API-Key", cfApiKey) resp, err := c.httpClient.Do(req) if err != nil { return nil, err } if resp.StatusCode != 200 { return nil, fmt.Errorf("invalid response status: %v", resp.Status) } return resp, nil } func (c *cfApiClient) makePost(endpoint string, body io.Reader) (*http.Response, error) { req, err := http.NewRequest("POST", "https://"+cfApiServer+endpoint, body) if err != nil { return nil, err } req.Header.Set("User-Agent", core.UserAgent) req.Header.Set("Accept", "application/json") req.Header.Set("Content-Type", "application/json") if cfApiKey == "" { cfApiKey = decodeDefaultKey() } req.Header.Set("X-API-Key", cfApiKey) resp, err := c.httpClient.Do(req) if err != nil { return nil, err } if resp.StatusCode != 200 { return nil, fmt.Errorf("invalid response status: %v", resp.Status) } return resp, nil } type fileType uint8 // noinspection GoUnusedConst const ( fileTypeRelease fileType = iota + 1 fileTypeBeta fileTypeAlpha ) type dependencyType uint8 // noinspection GoUnusedConst const ( dependencyTypeEmbedded dependencyType = iota + 1 dependencyTypeOptional dependencyTypeRequired dependencyTypeTool dependencyTypeIncompatible dependencyTypeInclude ) type modloaderType uint8 // noinspection GoUnusedConst const ( // modloaderTypeAny should not be passed to the API - it does not work modloaderTypeAny modloaderType = iota modloaderTypeForge modloaderTypeCauldron modloaderTypeLiteloader modloaderTypeFabric modloaderTypeQuilt modloaderTypeNeoForge ) var modloaderNames = [...]string{ "", "Forge", "Cauldron", "Liteloader", "Fabric", "Quilt", "NeoForge", } var modloaderIds = [...]string{ "", "forge", "cauldron", "liteloader", "fabric", "quilt", "neoforge", } type hashAlgo uint8 // noinspection GoUnusedConst const ( hashAlgoSHA1 hashAlgo = iota + 1 hashAlgoMD5 ) // modInfo is a subset of the deserialised JSON response from the Curse API for mods (addons) type modInfo struct { Name string `json:"name"` Summary string `json:"summary"` Slug string `json:"slug"` ID uint32 `json:"id"` GameID uint32 `json:"gameId"` PrimaryCategoryID uint32 `json:"primaryCategoryId"` ClassID uint32 `json:"classId"` LatestFiles []modFileInfo `json:"latestFiles"` GameVersionLatestFiles []struct { // TODO: check how twitch launcher chooses which one to use, when you are on beta/alpha channel?! // or does it not have the concept of release channels?! GameVersion string `json:"gameVersion"` ID uint32 `json:"fileId"` Name string `json:"filename"` FileType fileType `json:"releaseType"` Modloader modloaderType `json:"modLoader"` } `json:"latestFilesIndexes"` ModLoaders []string `json:"modLoaders"` Links struct { WebsiteURL string `json:"websiteUrl"` } `json:"links"` } func (c *cfApiClient) getModInfo(modID uint32) (modInfo, error) { var infoRes struct { Data modInfo `json:"data"` } idStr := strconv.FormatUint(uint64(modID), 10) resp, err := c.makeGet("/v1/mods/" + idStr) if err != nil { return modInfo{}, fmt.Errorf("failed to request project data for ID %d: %w", modID, err) } err = json.NewDecoder(resp.Body).Decode(&infoRes) if err != nil && err != io.EOF { return modInfo{}, fmt.Errorf("failed to request project data for ID %d: %w", modID, err) } if infoRes.Data.ID != modID { return modInfo{}, fmt.Errorf("unexpected project ID in CurseForge response: %d (expected %d)", infoRes.Data.ID, modID) } return infoRes.Data, nil } func (c *cfApiClient) getModInfoMultiple(modIDs []uint32) ([]modInfo, error) { var infoRes struct { Data []modInfo `json:"data"` } modIDsData, err := json.Marshal(struct { ModIDs []uint32 `json:"modIds"` }{ ModIDs: modIDs, }) if err != nil { return []modInfo{}, err } resp, err := c.makePost("/v1/mods", bytes.NewBuffer(modIDsData)) if err != nil { return []modInfo{}, fmt.Errorf("failed to request project data: %w", err) } err = json.NewDecoder(resp.Body).Decode(&infoRes) if err != nil && err != io.EOF { return []modInfo{}, fmt.Errorf("failed to request project data: %w", err) } return infoRes.Data, nil } // modFileInfo is a subset of the deserialised JSON response from the Curse API for mod files type modFileInfo struct { ID uint32 `json:"id"` ModID uint32 `json:"modId"` FileName string `json:"fileName"` FriendlyName string `json:"displayName"` Date time.Time `json:"fileDate"` Length uint64 `json:"fileLength"` FileType fileType `json:"releaseType"` // According to the CurseForge API T&Cs, this must not be saved or cached DownloadURL string `json:"downloadUrl"` GameVersions []string `json:"gameVersions"` Fingerprint uint32 `json:"fileFingerprint"` Dependencies []struct { ModID uint32 `json:"modId"` Type dependencyType `json:"relationType"` } `json:"dependencies"` Hashes []struct { Value string `json:"value"` Algorithm hashAlgo `json:"algo"` } `json:"hashes"` } func (i modFileInfo) getBestHash() (hash string, hashFormat string) { // TODO: check if the hash is invalid (e.g. 0) hash = strconv.FormatUint(uint64(i.Fingerprint), 10) hashFormat = "murmur2" hashPreferred := 0 // Prefer SHA1, then MD5 if found: if i.Hashes != nil { for _, v := range i.Hashes { if v.Algorithm == hashAlgoMD5 && hashPreferred < 1 { hashPreferred = 1 hash = v.Value hashFormat = "md5" } else if v.Algorithm == hashAlgoSHA1 && hashPreferred < 2 { hashPreferred = 2 hash = v.Value hashFormat = "sha1" } } } return } func (c *cfApiClient) getFileInfo(modID uint32, fileID uint32) (modFileInfo, error) { var infoRes struct { Data modFileInfo `json:"data"` } modIDStr := strconv.FormatUint(uint64(modID), 10) fileIDStr := strconv.FormatUint(uint64(fileID), 10) resp, err := c.makeGet("/v1/mods/" + modIDStr + "/files/" + fileIDStr) if err != nil { return modFileInfo{}, fmt.Errorf("failed to request file data for project ID %d, file ID %d: %w", modID, fileID, err) } err = json.NewDecoder(resp.Body).Decode(&infoRes) if err != nil && err != io.EOF { return modFileInfo{}, fmt.Errorf("failed to request file data for project ID %d, file ID %d: %w", modID, fileID, err) } if infoRes.Data.ID != fileID { return modFileInfo{}, fmt.Errorf("unexpected file ID for project %d in CurseForge response: %d (expected %d)", modID, infoRes.Data.ID, fileID) } return infoRes.Data, nil } func (c *cfApiClient) getFileInfoMultiple(fileIDs []uint32) ([]modFileInfo, error) { var infoRes struct { Data []modFileInfo `json:"data"` } fileIDsData, err := json.Marshal(struct { FileIDs []uint32 `json:"fileIds"` }{ FileIDs: fileIDs, }) if err != nil { return []modFileInfo{}, err } resp, err := c.makePost("/v1/mods/files", bytes.NewBuffer(fileIDsData)) if err != nil { return []modFileInfo{}, fmt.Errorf("failed to request file data: %w", err) } err = json.NewDecoder(resp.Body).Decode(&infoRes) if err != nil && err != io.EOF { return []modFileInfo{}, fmt.Errorf("failed to request file data: %w", err) } return infoRes.Data, nil } func (c *cfApiClient) getSearch(searchTerm string, slug string, gameID uint32, classID uint32, categoryID uint32, gameVersion string, modloaderType modloaderType) ([]modInfo, error) { var infoRes struct { Data []modInfo `json:"data"` } q := url.Values{} q.Set("gameId", strconv.FormatUint(uint64(gameID), 10)) q.Set("pageSize", "10") if classID != 0 { q.Set("classId", strconv.FormatUint(uint64(classID), 10)) } if slug != "" { q.Set("slug", slug) } // If classID and slug are provided, don't bother filtering by anything else (should be unique) if classID == 0 && slug == "" { if categoryID != 0 { q.Set("categoryId", strconv.FormatUint(uint64(categoryID), 10)) } if searchTerm != "" { q.Set("searchFilter", searchTerm) } if gameVersion != "" { q.Set("gameVersion", gameVersion) } if modloaderType != modloaderTypeAny { q.Set("modLoaderType", strconv.FormatUint(uint64(modloaderType), 10)) } } resp, err := c.makeGet("/v1/mods/search?" + q.Encode()) if err != nil { return []modInfo{}, fmt.Errorf("failed to retrieve search results: %w", err) } err = json.NewDecoder(resp.Body).Decode(&infoRes) if err != nil && err != io.EOF { return []modInfo{}, fmt.Errorf("failed to parse search results: %w", err) } return infoRes.Data, nil } type gameStatus uint8 // noinspection GoUnusedConst const ( gameStatusDraft gameStatus = iota + 1 gameStatusTest gameStatusPendingReview gameStatusRejected gameStatusApproved gameStatusLive ) type gameApiStatus uint8 // noinspection GoUnusedConst const ( gameApiStatusPrivate gameApiStatus = iota + 1 gameApiStatusPublic ) type cfGame struct { ID uint32 `json:"id"` Name string `json:"name"` Slug string `json:"slug"` Status gameStatus `json:"status"` APIStatus gameApiStatus `json:"apiStatus"` } func (c *cfApiClient) getGames() ([]cfGame, error) { var infoRes struct { Data []cfGame `json:"data"` } resp, err := c.makeGet("/v1/games") if err != nil { return []cfGame{}, fmt.Errorf("failed to retrieve game list: %w", err) } err = json.NewDecoder(resp.Body).Decode(&infoRes) if err != nil && err != io.EOF { return []cfGame{}, fmt.Errorf("failed to parse game list: %w", err) } return infoRes.Data, nil } type cfCategory struct { ID uint32 `json:"id"` Slug string `json:"slug"` IsClass bool `json:"isClass"` ClassID uint32 `json:"classId"` } func (c *cfApiClient) getCategories(gameID uint32) ([]cfCategory, error) { var infoRes struct { Data []cfCategory `json:"data"` } resp, err := c.makeGet("/v1/categories?gameId=" + strconv.FormatUint(uint64(gameID), 10)) if err != nil { return []cfCategory{}, fmt.Errorf("failed to retrieve category list for game %v: %w", gameID, err) } err = json.NewDecoder(resp.Body).Decode(&infoRes) if err != nil && err != io.EOF { return []cfCategory{}, fmt.Errorf("failed to parse category list for game %v: %w", gameID, err) } return infoRes.Data, nil } type addonFingerprintResponse struct { IsCacheBuilt bool `json:"isCacheBuilt"` ExactMatches []struct { ID uint32 `json:"id"` File modFileInfo `json:"file"` LatestFiles []modFileInfo `json:"latestFiles"` } `json:"exactMatches"` ExactFingerprints []uint32 `json:"exactFingerprints"` PartialMatches []uint32 `json:"partialMatches"` PartialMatchFingerprints struct{} `json:"partialMatchFingerprints"` InstalledFingerprints []uint32 `json:"installedFingerprints"` UnmatchedFingerprints []uint32 `json:"unmatchedFingerprints"` } func (c *cfApiClient) getFingerprintInfo(hashes []uint32) (addonFingerprintResponse, error) { var infoRes struct { Data addonFingerprintResponse `json:"data"` } hashesData, err := json.Marshal(struct { Fingerprints []uint32 `json:"fingerprints"` }{ Fingerprints: hashes, }) if err != nil { return addonFingerprintResponse{}, err } resp, err := c.makePost("/v1/fingerprints", bytes.NewBuffer(hashesData)) if err != nil { return addonFingerprintResponse{}, fmt.Errorf("failed to retrieve fingerprint results: %w", err) } err = json.NewDecoder(resp.Body).Decode(&infoRes) if err != nil && err != io.EOF { return addonFingerprintResponse{}, err } return infoRes.Data, nil }