2021-07-05 15:11:17 +00:00
// Copyright or © or Copr. happyDNS (2021)
//
2022-01-10 13:06:19 +00:00
// contact@happydomain.org
2021-07-05 15:11:17 +00:00
//
// This software is a computer program whose purpose is to provide a modern
// interface to interact with DNS systems.
//
// This software is governed by the CeCILL license under French law and abiding
// by the rules of distribution of free software. You can use, modify and/or
// redistribute the software under the terms of the CeCILL license as
// circulated by CEA, CNRS and INRIA at the following URL
// "http://www.cecill.info".
//
// As a counterpart to the access to the source code and rights to copy, modify
// and redistribute granted by the license, users are provided only with a
// limited warranty and the software's author, the holder of the economic
// rights, and the successive licensors have only limited liability.
//
// In this respect, the user's attention is drawn to the risks associated with
// loading, using, modifying and/or developing or reproducing the software by
// the user in light of its specific status of free software, that may mean
// that it is complicated to manipulate, and that also therefore means that it
// is reserved for developers and experienced professionals having in-depth
// computer knowledge. Users are therefore encouraged to load and test the
// software's suitability as regards their requirements in conditions enabling
// the security of their systems and/or data to be ensured and, more generally,
// to use and operate it in the same conditions as regards security.
//
// The fact that you are presently reading this means that you have had
// knowledge of the CeCILL license and that you accept its terms.
package api
import (
"fmt"
"log"
"net/http"
2021-05-21 23:06:23 +00:00
dnscontrol "github.com/StackExchange/dnscontrol/v3/providers"
2021-07-05 15:11:17 +00:00
"github.com/gin-gonic/gin"
2022-01-10 13:06:19 +00:00
"git.happydns.org/happydomain/config"
"git.happydns.org/happydomain/model"
"git.happydns.org/happydomain/providers"
"git.happydns.org/happydomain/storage"
2021-07-05 15:11:17 +00:00
)
func declareProvidersRoutes ( cfg * config . Options , router * gin . RouterGroup ) {
router . GET ( "/providers" , getProviders )
router . POST ( "/providers" , addProvider )
2021-05-22 00:02:24 +00:00
apiProvidersMetaRoutes := router . Group ( "/providers/:pid" )
apiProvidersMetaRoutes . Use ( ProviderMetaHandler )
apiProvidersMetaRoutes . DELETE ( "" , deleteProvider )
2021-05-20 06:07:05 +00:00
apiProviderRoutes := router . Group ( "/providers/:pid" )
apiProviderRoutes . Use ( ProviderHandler )
2021-05-22 00:10:36 +00:00
apiProviderRoutes . GET ( "" , GetProvider )
2021-05-22 00:02:24 +00:00
apiProviderRoutes . PUT ( "" , UpdateProvider )
2021-07-05 15:11:17 +00:00
2021-05-21 23:06:23 +00:00
apiProviderRoutes . GET ( "/domains" , getDomainsHostedByProvider )
2021-07-05 15:11:17 +00:00
}
func getProviders ( c * gin . Context ) {
user := c . MustGet ( "LoggedUser" ) . ( * happydns . User )
if providers , err := storage . MainStore . GetProviderMetas ( user ) ; err != nil {
c . AbortWithStatusJSON ( http . StatusBadRequest , gin . H { "errmsg" : err . Error ( ) } )
return
} else if len ( providers ) > 0 {
c . JSON ( http . StatusOK , providers )
} else {
c . JSON ( http . StatusOK , [ ] happydns . Provider { } )
}
}
func DecodeProvider ( c * gin . Context ) ( * happydns . ProviderCombined , int , error ) {
var ust happydns . ProviderMeta
err := c . ShouldBindJSON ( & ust )
if err != nil {
return nil , http . StatusBadRequest , err
}
us , err := providers . FindProvider ( ust . Type )
if err != nil {
2021-07-30 09:49:11 +00:00
log . Printf ( "%s: unable to find provider %s: %s" , c . ClientIP ( ) , ust . Type , err . Error ( ) )
2021-07-05 15:11:17 +00:00
return nil , http . StatusInternalServerError , fmt . Errorf ( "Sorry, we were unable to find the kind of provider in our database. Please report this issue." )
}
src := & happydns . ProviderCombined {
us ,
ust ,
}
err = c . ShouldBindJSON ( & src )
if err != nil {
return nil , http . StatusBadRequest , err
}
2021-05-21 11:08:18 +00:00
err = src . Validate ( )
2021-07-05 15:11:17 +00:00
if err != nil {
return nil , http . StatusBadRequest , err
}
return src , http . StatusOK , nil
}
2021-05-22 00:02:24 +00:00
func ProviderMetaHandler ( c * gin . Context ) {
// Extract provider ID
2022-10-25 16:16:34 +00:00
pid , err := happydns . NewIdentifierFromString ( string ( c . Param ( "pid" ) ) )
2021-05-22 00:02:24 +00:00
if err != nil {
c . AbortWithStatusJSON ( http . StatusBadRequest , gin . H { "errmsg" : fmt . Sprintf ( "Invalid provider id: %s" , err . Error ( ) ) } )
return
}
// Get a valid user
user := myUser ( c )
if user == nil {
c . AbortWithStatusJSON ( http . StatusUnauthorized , gin . H { "errmsg" : "User not defined." } )
return
}
// Retrieve provider meta
providermeta , err := storage . MainStore . GetProviderMeta ( user , pid )
if err != nil {
c . AbortWithStatusJSON ( http . StatusNotFound , gin . H { "errmsg" : "Provider not found." } )
return
}
// Continue
c . Set ( "providermeta" , providermeta )
c . Next ( )
}
2021-05-20 06:07:05 +00:00
func ProviderHandler ( c * gin . Context ) {
// Extract provider ID
2022-10-25 16:16:34 +00:00
pid , err := happydns . NewIdentifierFromString ( string ( c . Param ( "pid" ) ) )
2021-05-20 06:07:05 +00:00
if err != nil {
2021-07-30 09:49:11 +00:00
c . AbortWithStatusJSON ( http . StatusBadRequest , gin . H { "errmsg" : fmt . Sprintf ( "Invalid provider id: %s" , err . Error ( ) ) } )
2021-05-20 06:07:05 +00:00
return
}
// Get a valid user
user := myUser ( c )
if user == nil {
c . AbortWithStatusJSON ( http . StatusUnauthorized , gin . H { "errmsg" : "User not defined." } )
return
}
// Retrieve provider
provider , err := storage . MainStore . GetProvider ( user , pid )
if err != nil {
c . AbortWithStatusJSON ( http . StatusNotFound , gin . H { "errmsg" : "Provider not found." } )
return
}
// Continue
c . Set ( "provider" , provider )
c . Set ( "providermeta" , provider . ProviderMeta )
c . Next ( )
}
2021-05-22 00:10:36 +00:00
func GetProvider ( c * gin . Context ) {
2021-05-20 06:07:05 +00:00
provider := c . MustGet ( "provider" ) . ( * happydns . ProviderCombined )
c . JSON ( http . StatusOK , provider )
}
2021-07-05 15:11:17 +00:00
func addProvider ( c * gin . Context ) {
user := c . MustGet ( "LoggedUser" ) . ( * happydns . User )
src , statuscode , err := DecodeProvider ( c )
if err != nil {
c . AbortWithStatusJSON ( statuscode , gin . H { "errmsg" : err . Error ( ) } )
return
}
s , err := storage . MainStore . CreateProvider ( user , src . Provider , src . Comment )
if err != nil {
2021-07-30 09:49:11 +00:00
log . Println ( "%s unable to CreateProvider: %s" , c . ClientIP ( ) , err . Error ( ) )
2021-07-05 15:11:17 +00:00
c . AbortWithStatusJSON ( http . StatusInternalServerError , gin . H { "errmsg" : "Sorry, we are currently unable to create the given provider. Please try again later." } )
return
}
c . JSON ( http . StatusOK , s )
}
2021-05-21 23:06:23 +00:00
2021-05-22 00:02:24 +00:00
func UpdateProvider ( c * gin . Context ) {
provider := c . MustGet ( "provider" ) . ( * happydns . ProviderCombined )
src , statuscode , err := DecodeProvider ( c )
if err != nil {
c . AbortWithStatusJSON ( statuscode , gin . H { "errmsg" : err . Error ( ) } )
return
}
src . Id = provider . Id
src . OwnerId = provider . OwnerId
if err := storage . MainStore . UpdateProvider ( src ) ; err != nil {
2021-07-30 09:49:11 +00:00
log . Println ( "%s unable to UpdateProvider: %s" , c . ClientIP ( ) , err . Error ( ) )
2021-05-22 00:02:24 +00:00
c . AbortWithStatusJSON ( http . StatusInternalServerError , gin . H { "errmsg" : "Sorry, we are currently unable to update the provider. Please try again later." } )
return
}
c . JSON ( http . StatusOK , src )
}
func deleteProvider ( c * gin . Context ) {
user := c . MustGet ( "LoggedUser" ) . ( * happydns . User )
providermeta := c . MustGet ( "providermeta" ) . ( * happydns . ProviderMeta )
// Check if the provider has no more domain associated
domains , err := storage . MainStore . GetDomains ( user )
if err != nil {
2021-07-30 09:49:11 +00:00
log . Println ( "%s unable to GetDomains for user id=%x email=%s: %s" , c . ClientIP ( ) , user . Id , user . Email , err . Error ( ) )
2021-05-22 00:02:24 +00:00
c . AbortWithStatusJSON ( http . StatusInternalServerError , gin . H { "errmsg" : "Sorry, we are currently unable to perform this action. Please try again later." } )
return
}
for _ , domain := range domains {
2022-10-25 16:16:34 +00:00
if domain . IdProvider . Equals ( providermeta . Id ) {
2021-05-22 00:02:24 +00:00
c . AbortWithStatusJSON ( http . StatusBadRequest , gin . H { "errmsg" : "You cannot delete this provider because there is still some domains associated with it." } )
return
}
}
if err := storage . MainStore . DeleteProvider ( providermeta ) ; err != nil {
2021-07-30 09:49:11 +00:00
log . Println ( "%s unable to DeleteProvider %x for user id=%x email=%s: %s" , c . ClientIP ( ) , providermeta . Id , user . Id , user . Email , err . Error ( ) )
2021-05-22 00:02:24 +00:00
c . AbortWithStatusJSON ( http . StatusInternalServerError , gin . H { "errmsg" : "Sorry, we are currently unable to delete your provider. Please try again later." } )
return
}
c . JSON ( http . StatusNoContent , nil )
}
2021-05-21 23:06:23 +00:00
func getDomainsHostedByProvider ( c * gin . Context ) {
provider := c . MustGet ( "provider" ) . ( * happydns . ProviderCombined )
p , err := provider . NewDNSServiceProvider ( )
if err != nil {
c . AbortWithStatusJSON ( http . StatusBadRequest , gin . H { "errmsg" : fmt . Sprintf ( "Unable to instantiate the provider: %s" , err . Error ( ) ) } )
return
}
sr , ok := p . ( dnscontrol . ZoneLister )
if ! ok {
c . AbortWithStatusJSON ( http . StatusBadRequest , gin . H { "errmsg" : "Provider doesn't support domain listing." } )
return
}
domains , err := sr . ListZones ( )
if err != nil {
c . AbortWithStatusJSON ( http . StatusBadRequest , gin . H { "errmsg" : err . Error ( ) } )
return
}
c . JSON ( http . StatusOK , domains )
}