Merge pull request #1030 from ibi-group/override-feed-filenames

feat: support overriding feed filenames

Author: daniel-heppner-ibigroup

i18n/english.yml

@@ -319,6 +319,7 @@ components:
   FeedInfo:
     autoFetch: Auto fetch
     autoPublish: Auto publish
+    bundleFilename: Bundle Filename
     dateFormat: MMM D, YYYY 
     deployable: Deployable
     edit: Edit
@@ -661,6 +662,8 @@ components:
         title: Updates
     labels:
       title: Labels
+    bundleFilename: Override filename for GTFS bundle
+    bundleFilenameHint: Optional. Define a custom filename (without .zip) for this feed source when included in a GTFS bundle. The .zip extension is added automatically.
     make:
       private: Make private
       privateDesc: Make this feed source private.
@@ -673,6 +676,8 @@ components:
     rename: Rename
     save: Save
     title: Settings
+    invalidFilename: "Filename contains invalid characters (e.g., / \ : * ? \" < > | space) or ends with .zip."
+    filenamePlaceholder: e.g., agency_bundle
   GtfsIcons:
     agency:
       title: Edit agencies
@@ -759,6 +764,7 @@ components:
     title: Log in
   ManagerHeader:
     noUpdateYet: n/a
+    bundleFilename: Bundle Filename
     noUrl: (none)
     private: This feed source and all its versions are private.
   ManagerPage:

i18n/german.yml

@@ -342,6 +342,7 @@ components:
   FeedInfo:
     autoFetch: Automatischer Abruf
     autoPublish: Automatische Veröffentlichung
+    bundleFilename: Bundle Filename
     dateFormat: DD.MM.YYYY
     deployable: Deploybar
     edit: Bearbeiten
@@ -676,6 +677,10 @@ components:
         title: Aktualisierungen
     labels:
       title: Ettiketten
+    bundleFilename: Override filename for GTFS bundle
+    bundleFilenameHint: Optional. Define a custom filename (without .zip) for this feed source when included in a GTFS bundle. The .zip extension is added automatically.
+    invalidFilename: "Filename contains invalid characters (e.g., / \ : * ? \" < > | space) or ends with .zip."
+    filenamePlaceholder: e.g., agency_bundle
     make:
       private: Privat setzen
       privateDesc: Setzt diese Feed-Quelle auf Privat.
@@ -769,6 +774,7 @@ components:
     title: Anmelden
   ManagerHeader:
     noUpdateYet: keine
+    bundleFilename: Bundle Filename
     noUrl: (keine URL)
     private: Diese Feed-Quelle und all ihre Versionen sind privat.
   ManagerPage:

i18n/polish.yml

@@ -339,6 +339,7 @@ components:
   FeedInfo:
     autoFetch: Automatyczne pobieranie
     autoPublish: Automatycznie publikuj
+    bundleFilename: Bundle Filename
     dateFormat: MMM D, YYYY
     deployable: Rozmieszczany
     edit: Edytować
@@ -599,6 +600,8 @@ components:
       title: Automatic Fetch
       url: Feed source fetch URL
       urlButton: Change URL
+    bundleFilename: Override filename for GTFS bundle
+    bundleFilenameHint: Optional. Define a custom filename (without .zip) for this feed source when included in a GTFS bundle. The .zip extension is added automatically.
     confirmDelete: Are you sure you want to delete this project? This action cannot
       be undone and all feed sources and their versions will be permanently deleted.
     dangerZone: Danger Zone
@@ -668,6 +671,8 @@ components:
         title: Updates
     labels:
       title: Labels
+    invalidFilename: "Filename contains invalid characters (e.g., / \ : * ? \" < > | space) or ends with .zip."
+    filenamePlaceholder: e.g., agency_bundle
     make:
       private: Make private
       privateDesc: Make this feed source private.
@@ -760,6 +765,7 @@ components:
     title: Log in
   ManagerHeader:
     noUpdateYet: n/a
+    bundleFilename: Bundle Filename
     noUrl: (none)
     private: This feed source and all its versions are private.
   ManagerPage:

lib/manager/components/CreateFeedSource.js

@@ -23,6 +23,7 @@ import Loading from '../../common/components/Loading'
 import {FREQUENCY_INTERVALS} from '../../common/constants'
 import {isExtensionEnabled} from '../../common/util/config'
 import {validationState} from '../util'
+import {isValidFilename} from '../util/validation'
 import type {FetchFrequency, NewFeed} from '../../types'
 
 import FeedFetchFrequency from './FeedFetchFrequency'
@@ -35,6 +36,7 @@ type Props = {
 
 type Validation = {
   _form: boolean,
+  filename?: boolean,
   name?: boolean,
   url?: boolean
 }
@@ -77,12 +79,14 @@ export default class CreateFeedSource extends Component<Props, State> {
         deployable: false,
         fetchFrequency: 'DAYS',
         fetchInterval: 1,
+        filename: '',
         name: '',
         projectId: props.projectId,
         url: ''
       },
       validation: {
         _form: false,
+        filename: true,
         name: true,
         url: true
       }
@@ -145,10 +149,11 @@ export default class CreateFeedSource extends Component<Props, State> {
   _validateModel (model: NewFeed) {
     const validation: Validation = {
       _form: false,
-      name: !(!model.name || model.name.length === 0),
+      filename: isValidFilename(model.filename),
+      name: !!model.name && model.name.length > 0,
       url: !model.url || validator.isURL(model.url)
     }
-    validation._form = !!(validation.name && validation.url)
+    validation._form = !!(validation.name && validation.url && validation.filename)
     this.setState({ validation })
   }
 
@@ -194,6 +199,18 @@ export default class CreateFeedSource extends Component<Props, State> {
                     individually.
                   </small>
                 </FormGroup>
+                <FormGroup validationState={validationState(validation.filename)}>
+                  <ControlLabel>Override filename for bundle (optional)</ControlLabel>
+                  <FormControl
+                    disabled={!model.deployable}
+                    name={'filename'}
+                    onChange={this._onInputChange('filename')}
+                    placeholder='e.g., agency_bundle'
+                    value={model.filename}
+                  />
+                  <FormControl.Feedback />
+                  {!validation.filename && <HelpBlock>Invalid filename</HelpBlock>}
+                </FormGroup>
               </ListGroupItem>
             </ListGroup>
           </Panel>

lib/manager/components/FeedSourceTableRow.js

@@ -299,6 +299,15 @@ class FeedInfo extends PureComponent<{ feedSource: Feed, project: Project, user:
               {this.messages('autoPublish')}
             </Col>
           )}
+          {feedSource.filename && (
+            <Col xs={12}>
+              <Row>
+                <Col xs={12}>
+                  <Icon type='file-text-o' />{this.messages('bundleFilename')}: {feedSource.filename}.zip
+                </Col>
+              </Row>
+            </Col>
+          )}
           <Col xs={12}>
             <div className='feedSourceLabelRow'>
               {project.labels.length > 0 && (

lib/manager/components/GeneralSettings.js

@@ -9,6 +9,7 @@ import {
   ControlLabel,
   FormControl,
   FormGroup,
+  HelpBlock,
   InputGroup,
   ListGroup,
   ListGroupItem,
@@ -18,6 +19,7 @@ import {
 import * as feedsActions from '../actions/feeds'
 import { FREQUENCY_INTERVALS } from '../../common/constants'
 import {getComponentMessages} from '../../common/util/config'
+import {isValidFilename} from '../util/validation'
 import LabelAssigner from '../components/LabelAssigner'
 import type { Feed, FetchFrequency, Project } from '../../types'
 import type { ManagerUserState } from '../../types/reducers'
@@ -34,27 +36,44 @@ type Props = {
 }
 
 type State = {
+  filename?: ?string,
+  filenameError?: ?string,
+  filenameValidationState?: ?string,
   name?: ?string,
   url?: ?string
 }
 
 export default class GeneralSettings extends Component<Props, State> {
   messages = getComponentMessages('GeneralSettings')
-  state = {}
+  state: State = {
+    filename: undefined,
+    filenameError: null,
+    filenameValidationState: null,
+    name: undefined,
+    url: undefined
+  }
 
   _onChange = ({target}: SyntheticInputEvent<HTMLInputElement>) => {
     // Change empty string to null to avoid setting URL to empty string value.
     let value = target.value || null
     if (target.name === 'url' && value) value = value.trim()
-    this.setState({[target.name]: value})
+    const newState: State = {[target.name]: value}
+    // Validate filename if changed
+    if (target.name === 'filename') {
+      // Check for invalid characters and ensure it doesn't end with .zip (case-insensitive)
+      const isValid = isValidFilename(value)
+      newState.filenameValidationState = isValid ? 'success' : 'error'
+      newState.filenameError = isValid ? null : this.messages('invalidFilename')
+    }
+    this.setState(newState)
   }
 
   _onToggleDeployable = () => {
     const {feedSource, updateFeedSource} = this.props
     updateFeedSource(feedSource, {deployable: !feedSource.deployable})
   }
 
-  _getFormValue = (key: 'name' | 'url') => {
+  _getFormValue = (key: 'name' | 'url' | 'filename') => {
     // If state value does not exist (i.e., form is unedited), revert to value
     // from props.
     const value = typeof this.state[key] === 'undefined'
@@ -108,6 +127,11 @@ export default class GeneralSettings extends Component<Props, State> {
     updateFeedSource(feedSource, {url: this.state.url})
   }
 
+  _onSaveFilename = () => {
+    const {feedSource, updateFeedSource} = this.props
+    updateFeedSource(feedSource, {filename: this.state.filename})
+  }
+
   render () {
     const {
       confirmDeleteFeedSource,
@@ -117,7 +141,8 @@ export default class GeneralSettings extends Component<Props, State> {
     } = this.props
     const {
       name,
-      url
+      url,
+      filename
     } = this.state
     const autoFetchFeed = feedSource.retrievalMethod === 'FETCHED_AUTOMATICALLY'
     return (
@@ -157,6 +182,29 @@ export default class GeneralSettings extends Component<Props, State> {
                 <small>{this.messages('makeDeployableHint')}</small>
               </FormGroup>
             </ListGroupItem>
+            <ListGroupItem>
+              <FormGroup validationState={this.state.filenameValidationState}>
+                <ControlLabel>{this.messages('bundleFilename')}</ControlLabel>
+                <InputGroup>
+                  <FormControl
+                    disabled={disabled || !feedSource.deployable}
+                    placeholder={this.messages('filenamePlaceholder')}
+                    name={'filename'}
+                    onChange={this._onChange}
+                    value={this._getFormValue('filename')} />
+                  <InputGroup.Button>
+                    <Button
+                      // disable if no change or value is unchanged
+                      disabled={disabled || typeof filename === 'undefined' || filename === feedSource.filename || this.state.filenameValidationState === 'error'}
+                      onClick={this._onSaveFilename}>
+                      {this.messages('save')}
+                    </Button>
+                  </InputGroup.Button>
+                </InputGroup>
+                <small>{this.messages('bundleFilenameHint')}</small>
+                {this.state.filenameError && <HelpBlock>{this.state.filenameError}</HelpBlock>}
+              </FormGroup>
+            </ListGroupItem>
           </ListGroup>
         </Panel>
         <Panel>

lib/manager/components/ManagerHeader.js

@@ -100,6 +100,11 @@ export default class ManagerHeader extends Component<Props> {
               <Icon type='file-archive-o' />{' '}
               {this.getAverageFileSize(feedSource.feedVersionSummaries)}
             </li>
+            {feedSource.filename && (
+              <li>
+                <Icon type='file-text-o' /> {this.messages('bundleFilename')}: {feedSource.filename}.zip
+              </li>
+            )}
           </ul>
         </Col>
       </Row>

lib/manager/util/validation.js

@@ -0,0 +1,11 @@
+// @flow
+
+/**
+ * Checks if a filename is valid.
+ * A valid filename does not contain <>:"/\|?* characters and does not end with .zip (case-insensitive).
+ * An empty or null/undefined filename is also considered valid.
+ */
+export function isValidFilename (filename: ?string): boolean {
+  // Ensure only valid characters (no ., <>,:"/\\|?*, or space) are used
+  return !filename || /^[^<>:"/\\|?* .]*$/.test(filename)
+}

lib/types/index.js

@@ -416,10 +416,11 @@ export type Feed = FeedSourceSummary & {
   feedVersions?: Array<FeedVersion>,
   fetchFrequency?: FetchFrequency,
   fetchInterval?: number,
+  filename?: ?string,
   isCreating?: boolean,
   lastFetched?: ?number,
-  latestVersionId?: ?string,
-  name: string, // Flow throws an error if we don't duplicate this property in the types here.
+  latestVersionId?: ?string, // Flow throws an error if we don't duplicate this property in the types here.
+  name: string,
   noteCount: number,
   notes?: Array<Note>,
   organizationId: ?string,
@@ -440,10 +441,11 @@ export type NewFeed = {
   deployable?: boolean,
   fetchFrequency: FetchFrequency,
   fetchInterval: number,
+  filename?: string,
   name?: string,
   projectId: string,
   retrievalMethod?: string,
-  url?: string
+  url?: string,
 }
 
 type ValidationErrorPriority = 'HIGH' | 'MEDIUM' | 'LOW' | 'UNKNOWN'