diff --git a/app/build.gradle b/app/build.gradle index 5184567f9e..91698c8608 100644 --- a/app/build.gradle +++ b/app/build.gradle @@ -198,9 +198,9 @@ dependencies { testImplementation 'org.robolectric:robolectric:4.10.3' // gRPC backend - implementation 'io.grpc:grpc-okhttp:1.43.2' // CURRENT_GRPC_VERSION - implementation 'io.grpc:grpc-protobuf-lite:1.43.2' // CURRENT_GRPC_VERSION - implementation 'io.grpc:grpc-stub:1.43.2' // CURRENT_GRPC_VERSION + implementation 'io.grpc:grpc-okhttp:1.58.0' // CURRENT_GRPC_VERSION + implementation 'io.grpc:grpc-protobuf-lite:1.58.0' // CURRENT_GRPC_VERSION + implementation 'io.grpc:grpc-stub:1.58.0' // CURRENT_GRPC_VERSION implementation 'org.apache.tomcat:annotations-api:6.0.53' // View binding helper @@ -208,10 +208,10 @@ dependencies { } protobuf { - protoc { artifact = 'com.google.protobuf:protoc:3.19.2' } + protoc { artifact = 'com.google.protobuf:protoc:3.24.3' } plugins { javalite { artifact = "com.google.protobuf:protoc-gen-javalite:3.0.0" } - grpc { artifact = 'io.grpc:protoc-gen-grpc-java:1.43.2' } // CURRENT_GRPC_VERSION + grpc { artifact = 'io.grpc:protoc-gen-grpc-java:1.58.0' } // CURRENT_GRPC_VERSION } generateProtoTasks { all().each { task -> @@ -220,7 +220,8 @@ protobuf { } task.plugins { grpc { // Options added to --grpc_out - option 'lite' } + option 'lite' + } } } } diff --git a/app/src/main/java/de/tum/in/tumcampusapp/api/app/BackendClient.kt b/app/src/main/java/de/tum/in/tumcampusapp/api/app/BackendClient.kt index 14d195eddc..1e0ab495f5 100644 --- a/app/src/main/java/de/tum/in/tumcampusapp/api/app/BackendClient.kt +++ b/app/src/main/java/de/tum/in/tumcampusapp/api/app/BackendClient.kt @@ -1,8 +1,8 @@ package de.tum.`in`.tumcampusapp.api.app +import app.tum.campus.api.CampusGrpc +import app.tum.campus.api.GetNewsSourcesRequest +import app.tum.campus.api.GetUpdateNoteRequest import de.tum.`in`.tumcampusapp.BuildConfig -import de.tum.`in`.tumcampusapp.api.backend.CampusGrpc -import de.tum.`in`.tumcampusapp.api.backend.GetNewsSourcesRequest -import de.tum.`in`.tumcampusapp.api.backend.GetUpdateNoteRequest import de.tum.`in`.tumcampusapp.component.ui.news.model.NewsSources import de.tum.`in`.tumcampusapp.component.ui.updatenote.model.UpdateNote import io.grpc.ManagedChannelBuilder @@ -13,7 +13,7 @@ class BackendClient private constructor() { private var stub: CampusGrpc.CampusFutureStub init { - val managedChannel = ManagedChannelBuilder.forAddress("api-grpc.tum.app", 443).build() + val managedChannel = ManagedChannelBuilder.forAddress("api.tum.app", 443).build() stub = CampusGrpc.newFutureStub(managedChannel).withInterceptors(MetadataUtils.newAttachHeadersInterceptor(getHeaderMetaData())) } diff --git a/app/src/main/java/de/tum/in/tumcampusapp/component/ui/news/model/NewsSources.kt b/app/src/main/java/de/tum/in/tumcampusapp/component/ui/news/model/NewsSources.kt index 988153ea69..b60c53a94f 100644 --- a/app/src/main/java/de/tum/in/tumcampusapp/component/ui/news/model/NewsSources.kt +++ b/app/src/main/java/de/tum/in/tumcampusapp/component/ui/news/model/NewsSources.kt @@ -3,8 +3,8 @@ package de.tum.`in`.tumcampusapp.component.ui.news.model import androidx.room.Entity import androidx.room.PrimaryKey import androidx.room.RoomWarnings +import app.tum.campus.api.GetNewsSourcesReply import com.google.gson.annotations.SerializedName -import de.tum.`in`.tumcampusapp.api.backend.GetNewsSourcesReply /** * This class contains information about the source of a [News] item. diff --git a/app/src/main/java/de/tum/in/tumcampusapp/component/ui/updatenote/model/UpdateNote.kt b/app/src/main/java/de/tum/in/tumcampusapp/component/ui/updatenote/model/UpdateNote.kt index 37a795433b..47bc31319b 100644 --- a/app/src/main/java/de/tum/in/tumcampusapp/component/ui/updatenote/model/UpdateNote.kt +++ b/app/src/main/java/de/tum/in/tumcampusapp/component/ui/updatenote/model/UpdateNote.kt @@ -1,6 +1,6 @@ package de.tum.`in`.tumcampusapp.component.ui.updatenote.model -import de.tum.`in`.tumcampusapp.api.backend.GetUpdateNoteReply +import app.tum.campus.api.GetUpdateNoteReply data class UpdateNote(var updateNote: String) { companion object { diff --git a/app/src/main/java/de/tum/in/tumcampusapp/utils/Extensions.kt b/app/src/main/java/de/tum/in/tumcampusapp/utils/Extensions.kt index c2030acdfa..6c756369e2 100644 --- a/app/src/main/java/de/tum/in/tumcampusapp/utils/Extensions.kt +++ b/app/src/main/java/de/tum/in/tumcampusapp/utils/Extensions.kt @@ -19,6 +19,7 @@ import com.squareup.picasso.RequestCreator import de.tum.`in`.tumcampusapp.component.other.generic.drawer.NavItem import io.reactivex.disposables.CompositeDisposable import io.reactivex.disposables.Disposable +import org.joda.time.DateTime /** * Executes the block and return null in case of an [Exception]. @@ -180,3 +181,8 @@ inline fun View.layoutParams(block: T.() -> fun View.dpToPx(dp: Float): Int = context.dpToPx(dp) fun Context.dpToPx(dp: Float): Int = TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_DIP, dp, resources.displayMetrics).toInt() + +fun com.google.protobuf.Timestamp.toDateTime(): DateTime { + val timeMilis = this.seconds * 1000L + this.nanos / 1000000L + return DateTime(timeMilis) +} diff --git a/app/src/main/proto/backend.proto b/app/src/main/proto/backend.proto deleted file mode 100644 index 97978f849c..0000000000 --- a/app/src/main/proto/backend.proto +++ /dev/null @@ -1,36 +0,0 @@ -syntax = "proto3"; - -option go_package = "github.com/TUM-Dev/Campus-Backend/api"; -option java_multiple_files = true; -option java_package = "de.tum.in.tumcampusapp.api.backend"; -option java_outer_classname = "CampusApiProto"; - -package api; - -import "google/protobuf/timestamp.proto"; - -service Campus { - rpc GetNewsSources(GetNewsSourcesRequest) returns (GetNewsSourcesReply) {} - rpc GetUpdateNote (GetUpdateNoteRequest) returns (GetUpdateNoteReply) {} -} - -message GetNewsSourcesRequest {} - -message GetNewsSourcesReply { - repeated NewsSource sources = 1; -} - -message NewsSource { - string source = 1; - string title = 2; - string icon = 3; -} - -message GetUpdateNoteRequest{ - int64 version = 1; -} - -message GetUpdateNoteReply{ - string message = 1; - string version_name = 2; -} diff --git a/app/src/main/proto/google/api/annotations.proto b/app/src/main/proto/google/api/annotations.proto new file mode 100644 index 0000000000..efdab3db6c --- /dev/null +++ b/app/src/main/proto/google/api/annotations.proto @@ -0,0 +1,31 @@ +// Copyright 2015 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +syntax = "proto3"; + +package google.api; + +import "google/api/http.proto"; +import "google/protobuf/descriptor.proto"; + +option go_package = "google.golang.org/genproto/googleapis/api/annotations;annotations"; +option java_multiple_files = true; +option java_outer_classname = "AnnotationsProto"; +option java_package = "com.google.api"; +option objc_class_prefix = "GAPI"; + +extend google.protobuf.MethodOptions { + // See `HttpRule`. + HttpRule http = 72295728; +} diff --git a/app/src/main/proto/google/api/http.proto b/app/src/main/proto/google/api/http.proto new file mode 100644 index 0000000000..31d867a27d --- /dev/null +++ b/app/src/main/proto/google/api/http.proto @@ -0,0 +1,379 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +syntax = "proto3"; + +package google.api; + +option cc_enable_arenas = true; +option go_package = "google.golang.org/genproto/googleapis/api/annotations;annotations"; +option java_multiple_files = true; +option java_outer_classname = "HttpProto"; +option java_package = "com.google.api"; +option objc_class_prefix = "GAPI"; + +// Defines the HTTP configuration for an API service. It contains a list of +// [HttpRule][google.api.HttpRule], each specifying the mapping of an RPC method +// to one or more HTTP REST API methods. +message Http { + // A list of HTTP configuration rules that apply to individual API methods. + // + // **NOTE:** All service configuration rules follow "last one wins" order. + repeated HttpRule rules = 1; + + // When set to true, URL path parameters will be fully URI-decoded except in + // cases of single segment matches in reserved expansion, where "%2F" will be + // left encoded. + // + // The default behavior is to not decode RFC 6570 reserved characters in multi + // segment matches. + bool fully_decode_reserved_expansion = 2; +} + +// # gRPC Transcoding +// +// gRPC Transcoding is a feature for mapping between a gRPC method and one or +// more HTTP REST endpoints. It allows developers to build a single API service +// that supports both gRPC APIs and REST APIs. Many systems, including [Google +// APIs](https://github.com/googleapis/googleapis), +// [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC +// Gateway](https://github.com/grpc-ecosystem/grpc-gateway), +// and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature +// and use it for large scale production services. +// +// `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies +// how different portions of the gRPC request message are mapped to the URL +// path, URL query parameters, and HTTP request body. It also controls how the +// gRPC response message is mapped to the HTTP response body. `HttpRule` is +// typically specified as an `google.api.http` annotation on the gRPC method. +// +// Each mapping specifies a URL path template and an HTTP method. The path +// template may refer to one or more fields in the gRPC request message, as long +// as each field is a non-repeated field with a primitive (non-message) type. +// The path template controls how fields of the request message are mapped to +// the URL path. +// +// Example: +// +// service Messaging { +// rpc GetMessage(GetMessageRequest) returns (Message) { +// option (google.api.http) = { +// get: "/v1/{name=messages/*}" +// }; +// } +// } +// message GetMessageRequest { +// string name = 1; // Mapped to URL path. +// } +// message Message { +// string text = 1; // The resource content. +// } +// +// This enables an HTTP REST to gRPC mapping as below: +// +// HTTP | gRPC +// -----|----- +// `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")` +// +// Any fields in the request message which are not bound by the path template +// automatically become HTTP query parameters if there is no HTTP request body. +// For example: +// +// service Messaging { +// rpc GetMessage(GetMessageRequest) returns (Message) { +// option (google.api.http) = { +// get:"/v1/messages/{message_id}" +// }; +// } +// } +// message GetMessageRequest { +// message SubMessage { +// string subfield = 1; +// } +// string message_id = 1; // Mapped to URL path. +// int64 revision = 2; // Mapped to URL query parameter `revision`. +// SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. +// } +// +// This enables a HTTP JSON to RPC mapping as below: +// +// HTTP | gRPC +// -----|----- +// `GET /v1/messages/123456?revision=2&sub.subfield=foo` | +// `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: +// "foo"))` +// +// Note that fields which are mapped to URL query parameters must have a +// primitive type or a repeated primitive type or a non-repeated message type. +// In the case of a repeated type, the parameter can be repeated in the URL +// as `...?param=A¶m=B`. In the case of a message type, each field of the +// message is mapped to a separate parameter, such as +// `...?foo.a=A&foo.b=B&foo.c=C`. +// +// For HTTP methods that allow a request body, the `body` field +// specifies the mapping. Consider a REST update method on the +// message resource collection: +// +// service Messaging { +// rpc UpdateMessage(UpdateMessageRequest) returns (Message) { +// option (google.api.http) = { +// patch: "/v1/messages/{message_id}" +// body: "message" +// }; +// } +// } +// message UpdateMessageRequest { +// string message_id = 1; // mapped to the URL +// Message message = 2; // mapped to the body +// } +// +// The following HTTP JSON to RPC mapping is enabled, where the +// representation of the JSON in the request body is determined by +// protos JSON encoding: +// +// HTTP | gRPC +// -----|----- +// `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: +// "123456" message { text: "Hi!" })` +// +// The special name `*` can be used in the body mapping to define that +// every field not bound by the path template should be mapped to the +// request body. This enables the following alternative definition of +// the update method: +// +// service Messaging { +// rpc UpdateMessage(Message) returns (Message) { +// option (google.api.http) = { +// patch: "/v1/messages/{message_id}" +// body: "*" +// }; +// } +// } +// message Message { +// string message_id = 1; +// string text = 2; +// } +// +// +// The following HTTP JSON to RPC mapping is enabled: +// +// HTTP | gRPC +// -----|----- +// `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: +// "123456" text: "Hi!")` +// +// Note that when using `*` in the body mapping, it is not possible to +// have HTTP parameters, as all fields not bound by the path end in +// the body. This makes this option more rarely used in practice when +// defining REST APIs. The common usage of `*` is in custom methods +// which don't use the URL at all for transferring data. +// +// It is possible to define multiple HTTP methods for one RPC by using +// the `additional_bindings` option. Example: +// +// service Messaging { +// rpc GetMessage(GetMessageRequest) returns (Message) { +// option (google.api.http) = { +// get: "/v1/messages/{message_id}" +// additional_bindings { +// get: "/v1/users/{user_id}/messages/{message_id}" +// } +// }; +// } +// } +// message GetMessageRequest { +// string message_id = 1; +// string user_id = 2; +// } +// +// This enables the following two alternative HTTP JSON to RPC mappings: +// +// HTTP | gRPC +// -----|----- +// `GET /v1/messages/123456` | `GetMessage(message_id: "123456")` +// `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: +// "123456")` +// +// ## Rules for HTTP mapping +// +// 1. Leaf request fields (recursive expansion nested messages in the request +// message) are classified into three categories: +// - Fields referred by the path template. They are passed via the URL path. +// - Fields referred by the [HttpRule.body][google.api.HttpRule.body]. They +// are passed via the HTTP +// request body. +// - All other fields are passed via the URL query parameters, and the +// parameter name is the field path in the request message. A repeated +// field can be represented as multiple query parameters under the same +// name. +// 2. If [HttpRule.body][google.api.HttpRule.body] is "*", there is no URL +// query parameter, all fields +// are passed via URL path and HTTP request body. +// 3. If [HttpRule.body][google.api.HttpRule.body] is omitted, there is no HTTP +// request body, all +// fields are passed via URL path and URL query parameters. +// +// ### Path template syntax +// +// Template = "/" Segments [ Verb ] ; +// Segments = Segment { "/" Segment } ; +// Segment = "*" | "**" | LITERAL | Variable ; +// Variable = "{" FieldPath [ "=" Segments ] "}" ; +// FieldPath = IDENT { "." IDENT } ; +// Verb = ":" LITERAL ; +// +// The syntax `*` matches a single URL path segment. The syntax `**` matches +// zero or more URL path segments, which must be the last part of the URL path +// except the `Verb`. +// +// The syntax `Variable` matches part of the URL path as specified by its +// template. A variable template must not contain other variables. If a variable +// matches a single path segment, its template may be omitted, e.g. `{var}` +// is equivalent to `{var=*}`. +// +// The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` +// contains any reserved character, such characters should be percent-encoded +// before the matching. +// +// If a variable contains exactly one path segment, such as `"{var}"` or +// `"{var=*}"`, when such a variable is expanded into a URL path on the client +// side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The +// server side does the reverse decoding. Such variables show up in the +// [Discovery +// Document](https://developers.google.com/discovery/v1/reference/apis) as +// `{var}`. +// +// If a variable contains multiple path segments, such as `"{var=foo/*}"` +// or `"{var=**}"`, when such a variable is expanded into a URL path on the +// client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. +// The server side does the reverse decoding, except "%2F" and "%2f" are left +// unchanged. Such variables show up in the +// [Discovery +// Document](https://developers.google.com/discovery/v1/reference/apis) as +// `{+var}`. +// +// ## Using gRPC API Service Configuration +// +// gRPC API Service Configuration (service config) is a configuration language +// for configuring a gRPC service to become a user-facing product. The +// service config is simply the YAML representation of the `google.api.Service` +// proto message. +// +// As an alternative to annotating your proto file, you can configure gRPC +// transcoding in your service config YAML files. You do this by specifying a +// `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same +// effect as the proto annotation. This can be particularly useful if you +// have a proto that is reused in multiple services. Note that any transcoding +// specified in the service config will override any matching transcoding +// configuration in the proto. +// +// Example: +// +// http: +// rules: +// # Selects a gRPC method and applies HttpRule to it. +// - selector: example.v1.Messaging.GetMessage +// get: /v1/messages/{message_id}/{sub.subfield} +// +// ## Special notes +// +// When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the +// proto to JSON conversion must follow the [proto3 +// specification](https://developers.google.com/protocol-buffers/docs/proto3#json). +// +// While the single segment variable follows the semantics of +// [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String +// Expansion, the multi segment variable **does not** follow RFC 6570 Section +// 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion +// does not expand special characters like `?` and `#`, which would lead +// to invalid URLs. As the result, gRPC Transcoding uses a custom encoding +// for multi segment variables. +// +// The path variables **must not** refer to any repeated or mapped field, +// because client libraries are not capable of handling such variable expansion. +// +// The path variables **must not** capture the leading "/" character. The reason +// is that the most common use case "{var}" does not capture the leading "/" +// character. For consistency, all path variables must share the same behavior. +// +// Repeated message fields must not be mapped to URL query parameters, because +// no client library can support such complicated mapping. +// +// If an API needs to use a JSON array for request or response body, it can map +// the request or response body to a repeated field. However, some gRPC +// Transcoding implementations may not support this feature. +message HttpRule { + // Selects a method to which this rule applies. + // + // Refer to [selector][google.api.DocumentationRule.selector] for syntax + // details. + string selector = 1; + + // Determines the URL pattern is matched by this rules. This pattern can be + // used with any of the {get|put|post|delete|patch} methods. A custom method + // can be defined using the 'custom' field. + oneof pattern { + // Maps to HTTP GET. Used for listing and getting information about + // resources. + string get = 2; + + // Maps to HTTP PUT. Used for replacing a resource. + string put = 3; + + // Maps to HTTP POST. Used for creating a resource or performing an action. + string post = 4; + + // Maps to HTTP DELETE. Used for deleting a resource. + string delete = 5; + + // Maps to HTTP PATCH. Used for updating a resource. + string patch = 6; + + // The custom pattern is used for specifying an HTTP method that is not + // included in the `pattern` field, such as HEAD, or "*" to leave the + // HTTP method unspecified for this rule. The wild-card rule is useful + // for services that provide content to Web (HTML) clients. + CustomHttpPattern custom = 8; + } + + // The name of the request field whose value is mapped to the HTTP request + // body, or `*` for mapping all request fields not captured by the path + // pattern to the HTTP body, or omitted for not having any HTTP request body. + // + // NOTE: the referred field must be present at the top-level of the request + // message type. + string body = 7; + + // Optional. The name of the response field whose value is mapped to the HTTP + // response body. When omitted, the entire response message will be used + // as the HTTP response body. + // + // NOTE: The referred field must be present at the top-level of the response + // message type. + string response_body = 12; + + // Additional HTTP bindings for the selector. Nested bindings must + // not contain an `additional_bindings` field themselves (that is, + // the nesting may only be one level deep). + repeated HttpRule additional_bindings = 11; +} + +// A custom pattern is used for defining custom HTTP verb. +message CustomHttpPattern { + // The name of this custom HTTP verb. + string kind = 1; + + // The path matched by this custom verb. + string path = 2; +} diff --git a/app/src/main/proto/google/protobuf/descriptor.proto b/app/src/main/proto/google/protobuf/descriptor.proto new file mode 100644 index 0000000000..88df31a650 --- /dev/null +++ b/app/src/main/proto/google/protobuf/descriptor.proto @@ -0,0 +1,885 @@ +// Protocol Buffers - Google's data interchange format +// Copyright 2008 Google Inc. All rights reserved. +// https://developers.google.com/protocol-buffers/ +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +// Author: kenton@google.com (Kenton Varda) +// Based on original Protocol Buffers design by +// Sanjay Ghemawat, Jeff Dean, and others. +// +// The messages in this file describe the definitions found in .proto files. +// A valid .proto file can be translated directly to a FileDescriptorProto +// without any other information (e.g. without reading its imports). + + +syntax = "proto2"; + +package google.protobuf; + +option go_package = "github.com/golang/protobuf/protoc-gen-go/descriptor;descriptor"; +option java_package = "com.google.protobuf"; +option java_outer_classname = "DescriptorProtos"; +option csharp_namespace = "Google.Protobuf.Reflection"; +option objc_class_prefix = "GPB"; +option cc_enable_arenas = true; + +// descriptor.proto must be optimized for speed because reflection-based +// algorithms don't work during bootstrapping. +option optimize_for = SPEED; + +// The protocol compiler can output a FileDescriptorSet containing the .proto +// files it parses. +message FileDescriptorSet { + repeated FileDescriptorProto file = 1; +} + +// Describes a complete .proto file. +message FileDescriptorProto { + optional string name = 1; // file name, relative to root of source tree + optional string package = 2; // e.g. "foo", "foo.bar", etc. + + // Names of files imported by this file. + repeated string dependency = 3; + // Indexes of the public imported files in the dependency list above. + repeated int32 public_dependency = 10; + // Indexes of the weak imported files in the dependency list. + // For Google-internal migration only. Do not use. + repeated int32 weak_dependency = 11; + + // All top-level definitions in this file. + repeated DescriptorProto message_type = 4; + repeated EnumDescriptorProto enum_type = 5; + repeated ServiceDescriptorProto service = 6; + repeated FieldDescriptorProto extension = 7; + + optional FileOptions options = 8; + + // This field contains optional information about the original source code. + // You may safely remove this entire field without harming runtime + // functionality of the descriptors -- the information is needed only by + // development tools. + optional SourceCodeInfo source_code_info = 9; + + // The syntax of the proto file. + // The supported values are "proto2" and "proto3". + optional string syntax = 12; +} + +// Describes a message type. +message DescriptorProto { + optional string name = 1; + + repeated FieldDescriptorProto field = 2; + repeated FieldDescriptorProto extension = 6; + + repeated DescriptorProto nested_type = 3; + repeated EnumDescriptorProto enum_type = 4; + + message ExtensionRange { + optional int32 start = 1; // Inclusive. + optional int32 end = 2; // Exclusive. + + optional ExtensionRangeOptions options = 3; + } + repeated ExtensionRange extension_range = 5; + + repeated OneofDescriptorProto oneof_decl = 8; + + optional MessageOptions options = 7; + + // Range of reserved tag numbers. Reserved tag numbers may not be used by + // fields or extension ranges in the same message. Reserved ranges may + // not overlap. + message ReservedRange { + optional int32 start = 1; // Inclusive. + optional int32 end = 2; // Exclusive. + } + repeated ReservedRange reserved_range = 9; + // Reserved field names, which may not be used by fields in the same message. + // A given name may only be reserved once. + repeated string reserved_name = 10; +} + +message ExtensionRangeOptions { + // The parser stores options it doesn't recognize here. See above. + repeated UninterpretedOption uninterpreted_option = 999; + + // Clients can define custom options in extensions of this message. See above. + extensions 1000 to max; +} + +// Describes a field within a message. +message FieldDescriptorProto { + enum Type { + // 0 is reserved for errors. + // Order is weird for historical reasons. + TYPE_DOUBLE = 1; + TYPE_FLOAT = 2; + // Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT64 if + // negative values are likely. + TYPE_INT64 = 3; + TYPE_UINT64 = 4; + // Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT32 if + // negative values are likely. + TYPE_INT32 = 5; + TYPE_FIXED64 = 6; + TYPE_FIXED32 = 7; + TYPE_BOOL = 8; + TYPE_STRING = 9; + // Tag-delimited aggregate. + // Group type is deprecated and not supported in proto3. However, Proto3 + // implementations should still be able to parse the group wire format and + // treat group fields as unknown fields. + TYPE_GROUP = 10; + TYPE_MESSAGE = 11; // Length-delimited aggregate. + + // New in version 2. + TYPE_BYTES = 12; + TYPE_UINT32 = 13; + TYPE_ENUM = 14; + TYPE_SFIXED32 = 15; + TYPE_SFIXED64 = 16; + TYPE_SINT32 = 17; // Uses ZigZag encoding. + TYPE_SINT64 = 18; // Uses ZigZag encoding. + } + + enum Label { + // 0 is reserved for errors + LABEL_OPTIONAL = 1; + LABEL_REQUIRED = 2; + LABEL_REPEATED = 3; + } + + optional string name = 1; + optional int32 number = 3; + optional Label label = 4; + + // If type_name is set, this need not be set. If both this and type_name + // are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP. + optional Type type = 5; + + // For message and enum types, this is the name of the type. If the name + // starts with a '.', it is fully-qualified. Otherwise, C++-like scoping + // rules are used to find the type (i.e. first the nested types within this + // message are searched, then within the parent, on up to the root + // namespace). + optional string type_name = 6; + + // For extensions, this is the name of the type being extended. It is + // resolved in the same manner as type_name. + optional string extendee = 2; + + // For numeric types, contains the original text representation of the value. + // For booleans, "true" or "false". + // For strings, contains the default text contents (not escaped in any way). + // For bytes, contains the C escaped value. All bytes >= 128 are escaped. + // TODO(kenton): Base-64 encode? + optional string default_value = 7; + + // If set, gives the index of a oneof in the containing type's oneof_decl + // list. This field is a member of that oneof. + optional int32 oneof_index = 9; + + // JSON name of this field. The value is set by protocol compiler. If the + // user has set a "json_name" option on this field, that option's value + // will be used. Otherwise, it's deduced from the field's name by converting + // it to camelCase. + optional string json_name = 10; + + optional FieldOptions options = 8; +} + +// Describes a oneof. +message OneofDescriptorProto { + optional string name = 1; + optional OneofOptions options = 2; +} + +// Describes an enum type. +message EnumDescriptorProto { + optional string name = 1; + + repeated EnumValueDescriptorProto value = 2; + + optional EnumOptions options = 3; + + // Range of reserved numeric values. Reserved values may not be used by + // entries in the same enum. Reserved ranges may not overlap. + // + // Note that this is distinct from DescriptorProto.ReservedRange in that it + // is inclusive such that it can appropriately represent the entire int32 + // domain. + message EnumReservedRange { + optional int32 start = 1; // Inclusive. + optional int32 end = 2; // Inclusive. + } + + // Range of reserved numeric values. Reserved numeric values may not be used + // by enum values in the same enum declaration. Reserved ranges may not + // overlap. + repeated EnumReservedRange reserved_range = 4; + + // Reserved enum value names, which may not be reused. A given name may only + // be reserved once. + repeated string reserved_name = 5; +} + +// Describes a value within an enum. +message EnumValueDescriptorProto { + optional string name = 1; + optional int32 number = 2; + + optional EnumValueOptions options = 3; +} + +// Describes a service. +message ServiceDescriptorProto { + optional string name = 1; + repeated MethodDescriptorProto method = 2; + + optional ServiceOptions options = 3; +} + +// Describes a method of a service. +message MethodDescriptorProto { + optional string name = 1; + + // Input and output type names. These are resolved in the same way as + // FieldDescriptorProto.type_name, but must refer to a message type. + optional string input_type = 2; + optional string output_type = 3; + + optional MethodOptions options = 4; + + // Identifies if client streams multiple client messages + optional bool client_streaming = 5 [default = false]; + // Identifies if server streams multiple server messages + optional bool server_streaming = 6 [default = false]; +} + + +// =================================================================== +// Options + +// Each of the definitions above may have "options" attached. These are +// just annotations which may cause code to be generated slightly differently +// or may contain hints for code that manipulates protocol messages. +// +// Clients may define custom options as extensions of the *Options messages. +// These extensions may not yet be known at parsing time, so the parser cannot +// store the values in them. Instead it stores them in a field in the *Options +// message called uninterpreted_option. This field must have the same name +// across all *Options messages. We then use this field to populate the +// extensions when we build a descriptor, at which point all protos have been +// parsed and so all extensions are known. +// +// Extension numbers for custom options may be chosen as follows: +// * For options which will only be used within a single application or +// organization, or for experimental options, use field numbers 50000 +// through 99999. It is up to you to ensure that you do not use the +// same number for multiple options. +// * For options which will be published and used publicly by multiple +// independent entities, e-mail protobuf-global-extension-registry@google.com +// to reserve extension numbers. Simply provide your project name (e.g. +// Objective-C plugin) and your project website (if available) -- there's no +// need to explain how you intend to use them. Usually you only need one +// extension number. You can declare multiple options with only one extension +// number by putting them in a sub-message. See the Custom Options section of +// the docs for examples: +// https://developers.google.com/protocol-buffers/docs/proto#options +// If this turns out to be popular, a web service will be set up +// to automatically assign option numbers. + +message FileOptions { + + // Sets the Java package where classes generated from this .proto will be + // placed. By default, the proto package is used, but this is often + // inappropriate because proto packages do not normally start with backwards + // domain names. + optional string java_package = 1; + + + // If set, all the classes from the .proto file are wrapped in a single + // outer class with the given name. This applies to both Proto1 + // (equivalent to the old "--one_java_file" option) and Proto2 (where + // a .proto always translates to a single class, but you may want to + // explicitly choose the class name). + optional string java_outer_classname = 8; + + // If set true, then the Java code generator will generate a separate .java + // file for each top-level message, enum, and service defined in the .proto + // file. Thus, these types will *not* be nested inside the outer class + // named by java_outer_classname. However, the outer class will still be + // generated to contain the file's getDescriptor() method as well as any + // top-level extensions defined in the file. + optional bool java_multiple_files = 10 [default = false]; + + // This option does nothing. + optional bool java_generate_equals_and_hash = 20 [deprecated=true]; + + // If set true, then the Java2 code generator will generate code that + // throws an exception whenever an attempt is made to assign a non-UTF-8 + // byte sequence to a string field. + // Message reflection will do the same. + // However, an extension field still accepts non-UTF-8 byte sequences. + // This option has no effect on when used with the lite runtime. + optional bool java_string_check_utf8 = 27 [default = false]; + + + // Generated classes can be optimized for speed or code size. + enum OptimizeMode { + SPEED = 1; // Generate complete code for parsing, serialization, + // etc. + CODE_SIZE = 2; // Use ReflectionOps to implement these methods. + LITE_RUNTIME = 3; // Generate code using MessageLite and the lite runtime. + } + optional OptimizeMode optimize_for = 9 [default = SPEED]; + + // Sets the Go package where structs generated from this .proto will be + // placed. If omitted, the Go package will be derived from the following: + // - The basename of the package import path, if provided. + // - Otherwise, the package statement in the .proto file, if present. + // - Otherwise, the basename of the .proto file, without extension. + optional string go_package = 11; + + + + + // Should generic services be generated in each language? "Generic" services + // are not specific to any particular RPC system. They are generated by the + // main code generators in each language (without additional plugins). + // Generic services were the only kind of service generation supported by + // early versions of google.protobuf. + // + // Generic services are now considered deprecated in favor of using plugins + // that generate code specific to your particular RPC system. Therefore, + // these default to false. Old code which depends on generic services should + // explicitly set them to true. + optional bool cc_generic_services = 16 [default = false]; + optional bool java_generic_services = 17 [default = false]; + optional bool py_generic_services = 18 [default = false]; + optional bool php_generic_services = 42 [default = false]; + + // Is this file deprecated? + // Depending on the target platform, this can emit Deprecated annotations + // for everything in the file, or it will be completely ignored; in the very + // least, this is a formalization for deprecating files. + optional bool deprecated = 23 [default = false]; + + // Enables the use of arenas for the proto messages in this file. This applies + // only to generated classes for C++. + optional bool cc_enable_arenas = 31 [default = false]; + + + // Sets the objective c class prefix which is prepended to all objective c + // generated classes from this .proto. There is no default. + optional string objc_class_prefix = 36; + + // Namespace for generated classes; defaults to the package. + optional string csharp_namespace = 37; + + // By default Swift generators will take the proto package and CamelCase it + // replacing '.' with underscore and use that to prefix the types/symbols + // defined. When this options is provided, they will use this value instead + // to prefix the types/symbols defined. + optional string swift_prefix = 39; + + // Sets the php class prefix which is prepended to all php generated classes + // from this .proto. Default is empty. + optional string php_class_prefix = 40; + + // Use this option to change the namespace of php generated classes. Default + // is empty. When this option is empty, the package name will be used for + // determining the namespace. + optional string php_namespace = 41; + + // Use this option to change the namespace of php generated metadata classes. + // Default is empty. When this option is empty, the proto file name will be + // used for determining the namespace. + optional string php_metadata_namespace = 44; + + // Use this option to change the package of ruby generated classes. Default + // is empty. When this option is not set, the package name will be used for + // determining the ruby package. + optional string ruby_package = 45; + + + // The parser stores options it doesn't recognize here. + // See the documentation for the "Options" section above. + repeated UninterpretedOption uninterpreted_option = 999; + + // Clients can define custom options in extensions of this message. + // See the documentation for the "Options" section above. + extensions 1000 to max; + + reserved 38; +} + +message MessageOptions { + // Set true to use the old proto1 MessageSet wire format for extensions. + // This is provided for backwards-compatibility with the MessageSet wire + // format. You should not use this for any other reason: It's less + // efficient, has fewer features, and is more complicated. + // + // The message must be defined exactly as follows: + // message Foo { + // option message_set_wire_format = true; + // extensions 4 to max; + // } + // Note that the message cannot have any defined fields; MessageSets only + // have extensions. + // + // All extensions of your type must be singular messages; e.g. they cannot + // be int32s, enums, or repeated messages. + // + // Because this is an option, the above two restrictions are not enforced by + // the protocol compiler. + optional bool message_set_wire_format = 1 [default = false]; + + // Disables the generation of the standard "descriptor()" accessor, which can + // conflict with a field of the same name. This is meant to make migration + // from proto1 easier; new code should avoid fields named "descriptor". + optional bool no_standard_descriptor_accessor = 2 [default = false]; + + // Is this message deprecated? + // Depending on the target platform, this can emit Deprecated annotations + // for the message, or it will be completely ignored; in the very least, + // this is a formalization for deprecating messages. + optional bool deprecated = 3 [default = false]; + + // Whether the message is an automatically generated map entry type for the + // maps field. + // + // For maps fields: + // map map_field = 1; + // The parsed descriptor looks like: + // message MapFieldEntry { + // option map_entry = true; + // optional KeyType key = 1; + // optional ValueType value = 2; + // } + // repeated MapFieldEntry map_field = 1; + // + // Implementations may choose not to generate the map_entry=true message, but + // use a native map in the target language to hold the keys and values. + // The reflection APIs in such implementations still need to work as + // if the field is a repeated message field. + // + // NOTE: Do not set the option in .proto files. Always use the maps syntax + // instead. The option should only be implicitly set by the proto compiler + // parser. + optional bool map_entry = 7; + + reserved 8; // javalite_serializable + reserved 9; // javanano_as_lite + + + // The parser stores options it doesn't recognize here. See above. + repeated UninterpretedOption uninterpreted_option = 999; + + // Clients can define custom options in extensions of this message. See above. + extensions 1000 to max; +} + +message FieldOptions { + // The ctype option instructs the C++ code generator to use a different + // representation of the field than it normally would. See the specific + // options below. This option is not yet implemented in the open source + // release -- sorry, we'll try to include it in a future version! + optional CType ctype = 1 [default = STRING]; + enum CType { + // Default mode. + STRING = 0; + + CORD = 1; + + STRING_PIECE = 2; + } + // The packed option can be enabled for repeated primitive fields to enable + // a more efficient representation on the wire. Rather than repeatedly + // writing the tag and type for each element, the entire array is encoded as + // a single length-delimited blob. In proto3, only explicit setting it to + // false will avoid using packed encoding. + optional bool packed = 2; + + // The jstype option determines the JavaScript type used for values of the + // field. The option is permitted only for 64 bit integral and fixed types + // (int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING + // is represented as JavaScript string, which avoids loss of precision that + // can happen when a large value is converted to a floating point JavaScript. + // Specifying JS_NUMBER for the jstype causes the generated JavaScript code to + // use the JavaScript "number" type. The behavior of the default option + // JS_NORMAL is implementation dependent. + // + // This option is an enum to permit additional types to be added, e.g. + // goog.math.Integer. + optional JSType jstype = 6 [default = JS_NORMAL]; + enum JSType { + // Use the default type. + JS_NORMAL = 0; + + // Use JavaScript strings. + JS_STRING = 1; + + // Use JavaScript numbers. + JS_NUMBER = 2; + } + + // Should this field be parsed lazily? Lazy applies only to message-type + // fields. It means that when the outer message is initially parsed, the + // inner message's contents will not be parsed but instead stored in encoded + // form. The inner message will actually be parsed when it is first accessed. + // + // This is only a hint. Implementations are free to choose whether to use + // eager or lazy parsing regardless of the value of this option. However, + // setting this option true suggests that the protocol author believes that + // using lazy parsing on this field is worth the additional bookkeeping + // overhead typically needed to implement it. + // + // This option does not affect the public interface of any generated code; + // all method signatures remain the same. Furthermore, thread-safety of the + // interface is not affected by this option; const methods remain safe to + // call from multiple threads concurrently, while non-const methods continue + // to require exclusive access. + // + // + // Note that implementations may choose not to check required fields within + // a lazy sub-message. That is, calling IsInitialized() on the outer message + // may return true even if the inner message has missing required fields. + // This is necessary because otherwise the inner message would have to be + // parsed in order to perform the check, defeating the purpose of lazy + // parsing. An implementation which chooses not to check required fields + // must be consistent about it. That is, for any particular sub-message, the + // implementation must either *always* check its required fields, or *never* + // check its required fields, regardless of whether or not the message has + // been parsed. + optional bool lazy = 5 [default = false]; + + // Is this field deprecated? + // Depending on the target platform, this can emit Deprecated annotations + // for accessors, or it will be completely ignored; in the very least, this + // is a formalization for deprecating fields. + optional bool deprecated = 3 [default = false]; + + // For Google-internal migration only. Do not use. + optional bool weak = 10 [default = false]; + + + // The parser stores options it doesn't recognize here. See above. + repeated UninterpretedOption uninterpreted_option = 999; + + // Clients can define custom options in extensions of this message. See above. + extensions 1000 to max; + + reserved 4; // removed jtype +} + +message OneofOptions { + // The parser stores options it doesn't recognize here. See above. + repeated UninterpretedOption uninterpreted_option = 999; + + // Clients can define custom options in extensions of this message. See above. + extensions 1000 to max; +} + +message EnumOptions { + + // Set this option to true to allow mapping different tag names to the same + // value. + optional bool allow_alias = 2; + + // Is this enum deprecated? + // Depending on the target platform, this can emit Deprecated annotations + // for the enum, or it will be completely ignored; in the very least, this + // is a formalization for deprecating enums. + optional bool deprecated = 3 [default = false]; + + reserved 5; // javanano_as_lite + + // The parser stores options it doesn't recognize here. See above. + repeated UninterpretedOption uninterpreted_option = 999; + + // Clients can define custom options in extensions of this message. See above. + extensions 1000 to max; +} + +message EnumValueOptions { + // Is this enum value deprecated? + // Depending on the target platform, this can emit Deprecated annotations + // for the enum value, or it will be completely ignored; in the very least, + // this is a formalization for deprecating enum values. + optional bool deprecated = 1 [default = false]; + + // The parser stores options it doesn't recognize here. See above. + repeated UninterpretedOption uninterpreted_option = 999; + + // Clients can define custom options in extensions of this message. See above. + extensions 1000 to max; +} + +message ServiceOptions { + + // Note: Field numbers 1 through 32 are reserved for Google's internal RPC + // framework. We apologize for hoarding these numbers to ourselves, but + // we were already using them long before we decided to release Protocol + // Buffers. + + // Is this service deprecated? + // Depending on the target platform, this can emit Deprecated annotations + // for the service, or it will be completely ignored; in the very least, + // this is a formalization for deprecating services. + optional bool deprecated = 33 [default = false]; + + // The parser stores options it doesn't recognize here. See above. + repeated UninterpretedOption uninterpreted_option = 999; + + // Clients can define custom options in extensions of this message. See above. + extensions 1000 to max; +} + +message MethodOptions { + + // Note: Field numbers 1 through 32 are reserved for Google's internal RPC + // framework. We apologize for hoarding these numbers to ourselves, but + // we were already using them long before we decided to release Protocol + // Buffers. + + // Is this method deprecated? + // Depending on the target platform, this can emit Deprecated annotations + // for the method, or it will be completely ignored; in the very least, + // this is a formalization for deprecating methods. + optional bool deprecated = 33 [default = false]; + + // Is this method side-effect-free (or safe in HTTP parlance), or idempotent, + // or neither? HTTP based RPC implementation may choose GET verb for safe + // methods, and PUT verb for idempotent methods instead of the default POST. + enum IdempotencyLevel { + IDEMPOTENCY_UNKNOWN = 0; + NO_SIDE_EFFECTS = 1; // implies idempotent + IDEMPOTENT = 2; // idempotent, but may have side effects + } + optional IdempotencyLevel idempotency_level = 34 + [default = IDEMPOTENCY_UNKNOWN]; + + // The parser stores options it doesn't recognize here. See above. + repeated UninterpretedOption uninterpreted_option = 999; + + // Clients can define custom options in extensions of this message. See above. + extensions 1000 to max; +} + + +// A message representing a option the parser does not recognize. This only +// appears in options protos created by the compiler::Parser class. +// DescriptorPool resolves these when building Descriptor objects. Therefore, +// options protos in descriptor objects (e.g. returned by Descriptor::options(), +// or produced by Descriptor::CopyTo()) will never have UninterpretedOptions +// in them. +message UninterpretedOption { + // The name of the uninterpreted option. Each string represents a segment in + // a dot-separated name. is_extension is true iff a segment represents an + // extension (denoted with parentheses in options specs in .proto files). + // E.g.,{ ["foo", false], ["bar.baz", true], ["qux", false] } represents + // "foo.(bar.baz).qux". + message NamePart { + required string name_part = 1; + required bool is_extension = 2; + } + repeated NamePart name = 2; + + // The value of the uninterpreted option, in whatever type the tokenizer + // identified it as during parsing. Exactly one of these should be set. + optional string identifier_value = 3; + optional uint64 positive_int_value = 4; + optional int64 negative_int_value = 5; + optional double double_value = 6; + optional bytes string_value = 7; + optional string aggregate_value = 8; +} + +// =================================================================== +// Optional source code info + +// Encapsulates information about the original source file from which a +// FileDescriptorProto was generated. +message SourceCodeInfo { + // A Location identifies a piece of source code in a .proto file which + // corresponds to a particular definition. This information is intended + // to be useful to IDEs, code indexers, documentation generators, and similar + // tools. + // + // For example, say we have a file like: + // message Foo { + // optional string foo = 1; + // } + // Let's look at just the field definition: + // optional string foo = 1; + // ^ ^^ ^^ ^ ^^^ + // a bc de f ghi + // We have the following locations: + // span path represents + // [a,i) [ 4, 0, 2, 0 ] The whole field definition. + // [a,b) [ 4, 0, 2, 0, 4 ] The label (optional). + // [c,d) [ 4, 0, 2, 0, 5 ] The type (string). + // [e,f) [ 4, 0, 2, 0, 1 ] The name (foo). + // [g,h) [ 4, 0, 2, 0, 3 ] The number (1). + // + // Notes: + // - A location may refer to a repeated field itself (i.e. not to any + // particular index within it). This is used whenever a set of elements are + // logically enclosed in a single code segment. For example, an entire + // extend block (possibly containing multiple extension definitions) will + // have an outer location whose path refers to the "extensions" repeated + // field without an index. + // - Multiple locations may have the same path. This happens when a single + // logical declaration is spread out across multiple places. The most + // obvious example is the "extend" block again -- there may be multiple + // extend blocks in the same scope, each of which will have the same path. + // - A location's span is not always a subset of its parent's span. For + // example, the "extendee" of an extension declaration appears at the + // beginning of the "extend" block and is shared by all extensions within + // the block. + // - Just because a location's span is a subset of some other location's span + // does not mean that it is a descendant. For example, a "group" defines + // both a type and a field in a single declaration. Thus, the locations + // corresponding to the type and field and their components will overlap. + // - Code which tries to interpret locations should probably be designed to + // ignore those that it doesn't understand, as more types of locations could + // be recorded in the future. + repeated Location location = 1; + message Location { + // Identifies which part of the FileDescriptorProto was defined at this + // location. + // + // Each element is a field number or an index. They form a path from + // the root FileDescriptorProto to the place where the definition. For + // example, this path: + // [ 4, 3, 2, 7, 1 ] + // refers to: + // file.message_type(3) // 4, 3 + // .field(7) // 2, 7 + // .name() // 1 + // This is because FileDescriptorProto.message_type has field number 4: + // repeated DescriptorProto message_type = 4; + // and DescriptorProto.field has field number 2: + // repeated FieldDescriptorProto field = 2; + // and FieldDescriptorProto.name has field number 1: + // optional string name = 1; + // + // Thus, the above path gives the location of a field name. If we removed + // the last element: + // [ 4, 3, 2, 7 ] + // this path refers to the whole field declaration (from the beginning + // of the label to the terminating semicolon). + repeated int32 path = 1 [packed = true]; + + // Always has exactly three or four elements: start line, start column, + // end line (optional, otherwise assumed same as start line), end column. + // These are packed into a single field for efficiency. Note that line + // and column numbers are zero-based -- typically you will want to add + // 1 to each before displaying to a user. + repeated int32 span = 2 [packed = true]; + + // If this SourceCodeInfo represents a complete declaration, these are any + // comments appearing before and after the declaration which appear to be + // attached to the declaration. + // + // A series of line comments appearing on consecutive lines, with no other + // tokens appearing on those lines, will be treated as a single comment. + // + // leading_detached_comments will keep paragraphs of comments that appear + // before (but not connected to) the current element. Each paragraph, + // separated by empty lines, will be one comment element in the repeated + // field. + // + // Only the comment content is provided; comment markers (e.g. //) are + // stripped out. For block comments, leading whitespace and an asterisk + // will be stripped from the beginning of each line other than the first. + // Newlines are included in the output. + // + // Examples: + // + // optional int32 foo = 1; // Comment attached to foo. + // // Comment attached to bar. + // optional int32 bar = 2; + // + // optional string baz = 3; + // // Comment attached to baz. + // // Another line attached to baz. + // + // // Comment attached to qux. + // // + // // Another line attached to qux. + // optional double qux = 4; + // + // // Detached comment for corge. This is not leading or trailing comments + // // to qux or corge because there are blank lines separating it from + // // both. + // + // // Detached comment for corge paragraph 2. + // + // optional string corge = 5; + // /* Block comment attached + // * to corge. Leading asterisks + // * will be removed. */ + // /* Block comment attached to + // * grault. */ + // optional int32 grault = 6; + // + // // ignored detached comments. + optional string leading_comments = 3; + optional string trailing_comments = 4; + repeated string leading_detached_comments = 6; + } +} + +// Describes the relationship between generated code and its original source +// file. A GeneratedCodeInfo message is associated with only one generated +// source file, but may contain references to different source .proto files. +message GeneratedCodeInfo { + // An Annotation connects some span of text in generated code to an element + // of its generating .proto file. + repeated Annotation annotation = 1; + message Annotation { + // Identifies the element in the original source .proto file. This field + // is formatted the same as SourceCodeInfo.Location.path. + repeated int32 path = 1 [packed = true]; + + // Identifies the filesystem path to the original source .proto. + optional string source_file = 2; + + // Identifies the starting offset in bytes in the generated code + // that relates to the identified object. + optional int32 begin = 3; + + // Identifies the ending offset in bytes in the generated code that + // relates to the identified offset. The end offset should be one past + // the last relevant byte (so the length of the text = end - begin). + optional int32 end = 4; + } +} diff --git a/app/src/main/proto/tumdev/campus_backend.proto b/app/src/main/proto/tumdev/campus_backend.proto new file mode 100644 index 0000000000..b85476891f --- /dev/null +++ b/app/src/main/proto/tumdev/campus_backend.proto @@ -0,0 +1,613 @@ +syntax = "proto3"; + +package api; + +import "google/api/annotations.proto"; +import "google/protobuf/timestamp.proto"; + +option csharp_namespace = "CampusApiProto"; +option go_package = "github.com/TUM-Dev/Campus-Backend/api"; +option java_multiple_files = true; +option java_outer_classname = "CampusApiProto"; +option java_package = "app.tum.campus.api"; + +service Campus { + rpc GetTopNews(GetTopNewsRequest) returns (GetTopNewsReply) { + option (google.api.http) = {get: "/news/top"}; + } + + rpc GetNewsSources(GetNewsSourcesRequest) returns (GetNewsSourcesReply) { + option (google.api.http) = { + get: "/news/sources", + response_body: "sources" + }; + } + + rpc GetNews(GetNewsRequest) returns (GetNewsReply) { + option (google.api.http) = { + get: "/news/{last_news_id}", + response_body: "news" + }; + } + + rpc SearchRooms(SearchRoomsRequest) returns (SearchRoomsReply) { + option (google.api.http) = { + post: "/roomfinder/room/search", + body: "*", + response_body: "rooms" + }; + } + + // This endpoint retrieves Canteen Ratings from the Backend. + rpc GetCanteenRatings(GetCanteenRatingsRequest) returns (GetCanteenRatingsReply) { + option (google.api.http) = { + post: "/canteen/rating/get", + body: "*", + }; + } + + rpc GetDishRatings(GetDishRatingsRequest) returns (GetDishRatingsReply) { + option (google.api.http) = { + post: "/dish/rating/get", + body: "*", + }; + } + + rpc NewCanteenRating(NewCanteenRatingRequest) returns (NewCanteenRatingReply) { + option (google.api.http) = { + post: "/canteen/rating/new", + body: "*", + }; + } + + rpc NewDishRating(NewDishRatingRequest) returns (NewDishRatingReply) { + option (google.api.http) = { + post: "/dish/rating/new", + body: "*", + }; + } + + rpc GetAvailableDishTags(GetAvailableDishTagsRequest) returns (GetAvailableDishTagsReply) { + option (google.api.http) = { + get: "/dish/rating/allRatingTags", + response_body: "rating_tags" + }; + } + + rpc GetNameTags(GetNameTagsRequest) returns (GetNameTagsReply) { + option (google.api.http) = { + get: "/dish/rating/allDishTags", + response_body: "rating_tags" + }; + } + + rpc GetAvailableCanteenTags(GetAvailableCanteenTagsRequest) returns (GetAvailableCanteenTagsReply) { + option (google.api.http) = { + get: "/canteen/rating/allRatingTags", + response_body: "rating_tags" + }; + } + + rpc GetCanteens(GetCanteensRequest) returns (GetCanteensReply) { + option (google.api.http) = { + get: "/canteen/allCanteens", + response_body: "canteen" + }; + } + + rpc GetDishes(GetDishesRequest) returns (GetDishesReply) { + option (google.api.http) = { + get: "/dish/allDishes", + response_body: "dish" + }; + } + + rpc GetResponsiblePerson(GetResponsiblePersonRequest) returns (GetResponsiblePersonReply) { + option (google.api.http) = {get: "/barrierfree/contacts"}; + } + + rpc GetMoreInformation(GetMoreInformationRequest) returns (GetMoreInformationReply) { + option (google.api.http) = {get: "/barrierfree/moreInformation"}; + } + + rpc GetOpeningTimes(GetOpeningTimesRequest) returns (GetOpeningTimesReply) { + option (google.api.http) = {get: "/openingtimes/{language}"}; + } + + rpc GetUpdateNote(GetUpdateNoteRequest) returns (GetUpdateNoteReply) { + option (google.api.http) = {get: "/updatenote/{version}"}; + } + + rpc GetStudyRoomList(GetStudyRoomListRequest) returns (GetStudyRoomListReply) { + option (google.api.http) = {get: "/studyrooms"}; + } + + rpc GetKino(GetKinoRequest) returns (GetKinoReply) { + option (google.api.http) = {get: "/kino/{last_id}"}; + } + + rpc SendFeedback(SendFeedbackRequest) returns (SendFeedbackReply) { + option (google.api.http) = {post: "/feedback"}; + } + + rpc SendFeedbackImage(SendFeedbackImageRequest) returns (SendFeedbackImageReply) { + option (google.api.http) = {post: "/feedback/{id}/{image_nr}"}; + } + + rpc GetUploadStatus(GetUploadStatusRequest) returns (GetUploadStatusReply) { + option (google.api.http) = {get: "/device/uploaded/{lrz_id}"}; + } + + rpc GetNotification(GetNotificationRequest) returns (GetNotificationReply) { + option (google.api.http) = {get: "/notifications/{notification_id}"}; + } + + rpc GetNotificationConfirm(GetNotificationConfirmRequest) returns (GetNotificationConfirmReply) { + option (google.api.http) = {get: "/notifications/confirm/{notification_id}"}; + } + + rpc GetMembers(GetMembersRequest) returns (GetMembersReply) { + option (google.api.http) = {get: "/members/{lrz_id}"}; + } + + rpc GetCanteenHeadCount(GetCanteenHeadCountRequest) returns (GetCanteenHeadCountReply) { + option (google.api.http) = {get: "/canteen/headCount/{canteen_id}"}; + } + + // Endpoint for the iOS app to respond to background notifications requests + rpc IOSDeviceRequestResponse(IOSDeviceRequestResponseRequest) returns (IOSDeviceRequestResponseReply) { + option (google.api.http) = { + post: "/ios/notifications/deviceRequestResponse", + body: "*", + }; + } + + // Register an Android, iOS or Windows device for push notifications + rpc RegisterDevice(RegisterDeviceRequest) returns (RegisterDeviceReply) { + option (google.api.http) = { + post: "/device", + body: "*", + }; + } + + // Unregister it from push notifications + rpc RemoveDevice(RemoveDeviceRequest) returns (RemoveDeviceReply) { + option (google.api.http) = {delete: "/device/{device_id}"}; + } +} + +enum DeviceType { + IOS = 0; + ANDROID = 1; + WINDOWS = 2; +} + +message RegisterDeviceRequest { + string device_id = 1; + optional string public_key = 2; + DeviceType device_type = 3; +} + +message RegisterDeviceReply { + string device_id = 1; +} + +message RemoveDeviceRequest { + string device_id = 1; + DeviceType device_type = 2; +} + +message RemoveDeviceReply { + string device_id = 1; +} + +message IOSDeviceRequestResponseRequest { + string request_id = 1; + string payload = 2; +} + +message IOSDeviceRequestResponseReply { + string message = 1; +} + +message SearchRoomsRequest { + string query = 1; +} + +message SearchRoomsReply { + repeated Room rooms = 1; +} + +message Room { + int64 room_id = 1; + string room_code = 2; + string building_nr = 3; + string arch_id = 4; + string info = 5; + string address = 6; + string purpose = 7; + string campus = 8; + string name = 9; +} + +message News { + int64 id = 1; + string title = 2; + string text = 3; + string link = 4; + string image_url = 5; + string source = 6; + google.protobuf.Timestamp created = 7; + google.protobuf.Timestamp date = 8; +} + +message GetNewsReply { + repeated News news = 1; +} + +message GetNewsRequest { + // the last id of the news item received. 0 to get all news items + int32 last_news_id = 1; + // filter by news source id. 0 to get all news items + int32 news_source = 2; +} + +message GetNewsSourcesRequest {} + +message GetNewsSourcesReply { + repeated NewsSource sources = 1; +} + +message NewsSource { + string source = 1; + string title = 2; + string icon = 3; +} + +message GetTopNewsRequest {} +message GetTopNewsReply { + string image_url = 1; + string link = 2; + google.protobuf.Timestamp created = 3; + google.protobuf.Timestamp from = 4; + google.protobuf.Timestamp to = 5; +} + +message GetCanteenRatingsRequest { + // canteenId Mandatory Name of the canteen (EAT-API naming scheme "MENSA_GARCHING") + string canteen_id = 1; + // Optional Parameter to define an interval for the ratings (Lower bound) + google.protobuf.Timestamp from = 2; + // Optional Parameter to define an interval for the ratings (Upper bound) + google.protobuf.Timestamp to = 3; + + // Optional Parameter defines how many ratings are queried. If all ratings should be queried, enter "-1" + int32 limit = 4; +} +message GetCanteenRatingsReply { + repeated SingleRatingReply rating = 1; + double avg = 2; + double std = 3; + int32 min = 4; + int32 max = 5; + repeated RatingTagResult rating_tags = 6; +} + +message GetDishRatingsRequest { + // Mandatory Name of the canteen (EAT-API naming scheme "MENSA_GARCHING") + string canteen_id = 1; + // Mandatory Name of the dish (EAT-API naming scheme) Must be available int the given mensa + string dish = 2; + // Optional Parameter to define an interval for the ratings (Lower bound) + google.protobuf.Timestamp from = 3; + // Optional Parameter to define an interval for the ratings (Upper bound) + google.protobuf.Timestamp to = 4; + // Optional Parameter defines how many ratings are queried. If all ratings should be queried, enter "-1" + int32 limit = 5; +} + +message GetDishRatingsReply { + repeated SingleRatingReply rating = 1; + double avg = 2; + double std = 3; + int32 min = 4; + int32 max = 5; + repeated RatingTagResult rating_tags = 6; + repeated RatingTagResult name_tags = 7; +} + +message SingleRatingReply { + // number in the range 1-5 + int32 points = 1; + // Optional JPEG image in Base64 + bytes image = 2; + // Optional comment (max 256 chars) + string comment = 3; + repeated RatingTagNewRequest rating_tags = 4; + google.protobuf.Timestamp visited = 5; +} + +message NewCanteenRatingReply {} + +message NewCanteenRatingRequest { + // number in the range 1-5 + int32 points = 1; + string canteen_id = 2; + bytes image = 3; + // Optional list of tag ratings add as many tags with a rating (1-5) of the list of canteenRatingTags + repeated RatingTag rating_tags = 4; + // Optional comment (max 256 chars) + string comment = 6; +} + +message NewDishRatingReply {} +message NewDishRatingRequest { + // number in the range 1-5 + int32 points = 1; + // Mandatory Name of the dish (EAT-API naming scheme "MENSA_GARCHING") Must be available int the given mensa + string canteen_id = 2; + // Mandatory Name of the dish (EAT-API naming scheme) Must be available int the given mensa + string dish = 3; + // Optional JPEG image in Base64 + bytes image = 4; + // Optional list of tag ratings add as many tags with a rating (1-5) of the list of dishRatingTags + repeated RatingTag rating_tags = 5; + // Optional comment (max 256 chars) + string comment = 7; +} + +message GetAvailableDishTagsRequest {} +message GetAvailableDishTagsReply { + repeated TagsOverview rating_tags = 1; +} + +message GetNameTagsRequest {} +message GetNameTagsReply { + repeated TagsOverview rating_tags = 1; +} + +message GetAvailableCanteenTagsRequest {} +message GetAvailableCanteenTagsReply { + repeated TagsOverview rating_tags = 1; +} + +message TagsOverview { + int32 tag_id = 1; + string de = 2; + string en = 3; +} + +message RatingTag { + int64 tag_id = 1; + double points = 2; +} + +message RatingTagNewRequest { + int32 tag_id = 1; + int32 points = 2; +} + +message RatingTagResult { + int32 tag_id = 1; + double avg = 2; + double std = 3; + int32 min = 4; + int32 max = 5; +} + +message GetCanteensRequest {} +message GetCanteensReply { + repeated Canteen canteen = 1; +} + +message Canteen { + string id = 1; + string address = 2; + double longitude = 3; + double latitude = 4; +} + +message GetDishesRequest { + string canteen_id = 1; + // >=2022 until the current year + int32 year = 2; + // range 1 - 53 + int32 week = 3; + // range 0 (Monday) - 4 (Friday) + int32 day = 4; +} + +message GetDishesReply { + repeated string dish = 1; +} + +message GetResponsiblePersonRequest {} +message GetResponsiblePersonReply { + repeated ResponsiblePerson responsible_person = 1; +} + +message ResponsiblePerson { + string name = 1; + string telephone = 2; + string email = 3; + string faculty = 4; + string tum_id = 5; +} + +message RoomInformationElement { + int32 room_id = 1; + string room_code = 2; + string building_nr = 3; + string arch_id = 4; + string info = 5; + string address = 6; + string purpose = 7; + string campus = 8; + string name = 9; +} + +message GetMoreInformationRequest {} +message GetMoreInformationReply { + message MoreInformation { + string title = 1; + string category = 2; + string url = 3; + } + repeated MoreInformation infos = 1; +} + +message GetOpeningTimesRequest { + string language = 1; +} + +message GetOpeningTimesReply { + repeated OpeningTimesMsgElement facilities = 1; +} + +message OpeningTimesMsgElement { + int32 id = 1; + string category = 2; + string name = 3; + string address = 4; + string room = 5; + string transport_station = 6; + string opening_hours = 7; + string infos = 8; + string url = 9; + string language = 10; + int32 reference_id = 11; +} + +message GetUpdateNoteRequest { + int64 version = 1; +} + +message GetUpdateNoteReply { + string message = 1; + string version_name = 2; +} + +message GetStudyRoomListRequest {} +message GetStudyRoomListReply { + repeated StudyRoomMsgElement rooms = 1; +} +message StudyRoomMsgElement { + int32 id = 1; + string name = 2; + string details = 3; + repeated StudyRoom rooms = 4; +} + +message StudyRoom { + int32 group_id = 1; + int32 room_id = 2; + string room_code = 3; + string room_name = 4; + string building_name = 5; +} + +message GetKinoRequest { + int32 last_id = 1; +} + +message GetKinoReply { + repeated KinoMsgElement kinos = 1; +} + +message KinoMsgElement { + string name = 1; + string path = 2; + int32 kino = 3; + google.protobuf.Timestamp date = 4; + google.protobuf.Timestamp created = 5; + string title = 6; + string year = 7; + string runtime = 8; + string genre = 9; + string director = 10; + string actors = 11; + string rating = 12; + string description = 13; + int32 cover = 14; + string trailer = 15; + string link = 16; +} + +message SendFeedbackReply {} +message SendFeedbackRequest { + string topic = 1; + string email = 2; + string email_id = 3; + string message = 4; + int32 image_count = 5; + double latitude = 6; + double longitude = 7; + string os_version = 8; + string app_version = 9; +} + +message SendFeedbackImageReply { + string status = 1; +} + +message SendFeedbackImageRequest { + int32 id = 1; + int32 image_nr = 2; + //todo where does the file come from? +} + +message GetMembersRequest { + string lrz_id = 1; +} + +message GetMembersReply { + string lrz_id = 1; + string name = 2; + int32 member_id = 3; +} + +message GetUploadStatusRequest { + string lrz_id = 1; +} + +message GetUploadStatusReply { + string fcm_token = 1; + string public_key = 2; + bool student_id = 3; + bool employee_id = 4; + bool external_id = 5; +} + +message GetNotificationRequest { + int32 notification_id = 1; +} +message GetNotificationReply { + int32 notification_id = 1; + int32 type = 2; + string title = 3; + string description = 4; + string signature = 5; +} + +message GetNotificationConfirmRequest { + int32 notification_id = 1; +} +message GetNotificationConfirmReply { + string status = 1; +} + +message GetCanteenHeadCountRequest { + // The requested canteen ID + string canteen_id = 1; +} + +message GetCanteenHeadCountReply { + // The absolut count of humans in the canteen. Only valid in case percent != -1. + uint32 count = 1; + // The maximum nunmber of humans in the canteen for the percent to be 100.00. Only valid in case percent != -1. + uint32 max_count = 2; + // Current capacity utilization of the canteen clamped to 0 and 100 or -1 in case no data is available. + float percent = 3; + // A time stamp indicating how up to date the response is. Only valid in case percent != -1. + google.protobuf.Timestamp timestamp = 4; +} diff --git a/proguard/proguard-grpc.pro b/proguard/proguard-grpc.pro new file mode 100644 index 0000000000..6e115675d2 --- /dev/null +++ b/proguard/proguard-grpc.pro @@ -0,0 +1,6 @@ +-dontwarn com.google.common.** +# Ignores: can't find referenced class javax.lang.model.element.Modifier +-dontwarn com.google.errorprone.annotations.** +-dontwarn javax.naming.** +-dontwarn okio.** +-dontwarn sun.misc.Unsafe \ No newline at end of file